Documenting APIs

Swagger = Openapi 2.0

Published: Monday, Nov 8, 2021 Last modified: Tuesday, Nov 26, 2024

AWS supports:

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: