< Enter your API summary here>
< Enter your API background here>
< Enter API Future Roadmap and Versioning information here.
If there is no future roadmap, include the below statement:
Currently, there is no ongoing work with this API outside of general maintenance.>
< Enter supporting documentation such as Architecture diagrams. In case, you are providing any supporting links like wiki, confluence etc. please make sure that they are public i.e. they should be accessible to everyone.
If there is no supporting documentation, include the below statement:
No supporting documentation included. >
< Enter bulleted list of related APIs. If none, include the below statement:
This API is unique and therefore has no related APIs.>
< In this section you should include all the necessary dependencies the consumer will need before they can start to use the API>
< In this section you should detail the necessary steps for a developer to start consuming the API.>
For REST APIs:
GET /<endpoint1 >
< Enter one line description of the endpoint >
POST /<endpoint2 >
< Enter one line description of the endpoint >
For GraphQL APIs:
Query /<endpoint1 >
< Enter one line description of the endpoint >
Mutation /<endpoint2 >
< Enter one line description of the endpoint >
For Async APIs:
PUB /<endpoint1 >
< Enter one line description of the endpoint >
SUB /<endpoint2 >
< Enter one line description of the endpoint >
For SOAP APIs:
GET /<endpoint1 >
< Enter one line description of the endpoint >
POST /<endpoint2 >
< Enter one line description of the endpoint >
< Include information on your API deployment (e.g. Test and Production Environments in AWS N.Virginia Region), including any consumption restrictions i.e. Region and Identity restrictions.>
< Enter the Token and Authentication mechanisms for your API (please do not share any private keys)>
< Mention if a support model exists for your API. This may include a general email/contact to reach out for queries, well known issues with the API, and their solutions if any.>
Product Manager:
Technical Lead:
Architect: