Automated documentation

API

Context

Writing an HTTP API.

Guides

  • Use API documentation like Swagger or OpenAPI automatically provide a playground for clients.

  • When Swagger or OpenAPI are not possible, make a Postman collection of sample requests for the API, with actual sample request bodies, and include a step in CI to run Postman tests against that collection. Then use the Postman Collection as external API documentation.

Resources