Design an API

This guidance is for teams designing an API microservice.

Follow these steps in order to set up your API's documentation, access controls, and specification.

Steps to follow

  1. Update the API definition
  2. Set up API access controls
  3. Update the API overview
  4. Write the OpenAPI specification (OAS)
  5. Add reusable parameters to your API specification
  6. Manage API authorisations and access controls
  7. Set up API access scopes
  8. Assign access levels to an API endpoint

Need support? If you are blocked at any step, contact your support route for help.

Got feedback? We are always improving this guidance. Share feedback to help improve the documentation.