Research and document an Alpha API

This guidance is for teams researching and documenting an API microservice during its Alpha development phase.

Steps to follow

  1. Preview the OAS documentation locally
  2. Deploy and publish the alpha API
  3. Self-approve the alpha API in the access approval tool
  4. View API documentation in a test environment
  5. Publish the alpha API to a sandbox environment
  6. Create an end-to-end service guide or roadmap

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.