OpenAPI¶
The OpenAPI specification provides a structured description of the operations, parameters, responses and resources made available by the service.
Machine-readable specification¶
Interactive documentation¶
Use¶
The specification can be used to:
- identify endpoints;
- identify parameters;
- check responses and formats;
- generate clients;
- validate integrations;
- automate tests;
- document applications.
Recommendation
For long-term integrations, use only operations and parameters documented in the OpenAPI specification. Avoid relying on undocumented behaviour.