Platform of Trust Platform Design Guide
Developer PortalAPI DocsOntology
  • Purpose and scope
  • Developer eXperience Strategy
  • Suggest changes
  • API Requests
    • Request validation
    • Response codes used
    • Error handling
  • General API guidelines
    • Performance
    • Documentation
    • Data models used
    • Use HATEOAS
    • Use HTTP Methods
    • Dates and time
    • Naming conventions
    • Pagination, partial response and sorting
    • API Testing
  • API Headers
    • Mandatory elements & behaviour
    • Rate limiting information
  • API Security
    • Authentication and authorization
    • SSL everywhere - all the time
  • API versioning guidelines
    • Versioning Rules
    • Breaking changes
    • Non-breaking changes example
    • Retirement process
    • Add new API to documentation
    • Add new endpoint
  • API Migration Policies
    • Deprecating API
    • Sunsetting API
    • Blackout Testing
    • Migration Email Template
    • API Blackout Test Email Template
    • API Deprecation Email
    • Deprecating an older API
  • Ontologies
    • About ontologies
    • Web Ontology Language, OWL
    • Ontology editor
    • Edit ontology
    • Add new subclass
    • Naming convention logic
    • Extending the ontology
  • Design Guideline
    • Colors
    • Typography
    • Grids and Space
    • Input forms - Text field
    • Input forms - Text area
    • Buttons
    • Checkbox
    • Radio buttons
    • Date picker
    • Form control - Single select
    • Toggle
    • Pagination
    • Status pills
    • Tables
    • Effects
    • Dialogues
Powered by GitBook
On this page

Was this helpful?

  1. API versioning guidelines

Add new API to documentation

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

PreviousRetirement processNextAdd new endpoint

Last updated 5 years ago

Was this helpful?

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: api-name_METHOD_endpointpath.md

    • For example Broker API POST method: broker-api_POST_broker_version_fetch-data-product.md

  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.

https://github.com/PlatformOfTrust/docs/tree/master/raml2markdown/src
https://github.com/PlatformOfTrust/docs/tree/master/raml2markdown/examples
build.py