Add new API to documentation

Follow these steps when ever you expose new API to the developers.

Steps to follow:

  1. Ensure that RAML is valid. Use validator tools.

  2. Add RAML file (+ includes) to

    • Create folder for new API and follow filename format: apiname-api

      • For example Broker API is broker-api, Identity API is identity-api.

    • Ensure that methods in the RAML are listed always in the same order:

      • Add something (POST)

      • Display (GET)

      • Update something / or replace (PUT)

      • Update / modify (PATCH)

      • remove something (DELETE)

  3. Add code example files for each endpoint and method to:

    • Filename format:

    • For example Broker API POST method:

  4. Modify array variable APIs in to include the name of the folder you created in step 1. so that it is included in build process.

Last updated