Documenting APIs
Swagger = Openapi 2.0
Published: Monday, Nov 8, 2021 Last modified: Tuesday, Nov 26, 2024
- https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
- https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md
The majority of mature tooling is around “Swagger” aka OpenAPI 2.0.
https://github.com/stoplightio/spectral is able to perform validation / linting for either.
The case against OpenAPI
A lighter weight approach of defining APIs without YAML. For example:
- Using Postman collections
- Providing curl examples / language specific examples e.g. https://stripe.com/docs/api?lang=go or https://stripe.com/docs/api?lang=curl