1. I'd Rather Be Writing
2. Learn API Doc
3. OpenAPI spec and generated reference docs

OpenAPI spec and generated reference docs

The OpenAPI specification provides a formal way of describing your REST API and includes all the reference sections mentioned in the previous section, Documenting API endpoints. Display frameworks such as Swagger UI can parse the OpenAPI specification and generate interactive documentation that lets users try out endpoints while learning about the API.

Sections in this chapter:

• Overview of REST API specification formats
• Introduction to the OpenAPI specification
• Stoplight: Visual modeling tools for creating your spec
• Getting started tutorial: Using Stoplight Studio to create an OpenAPI specification document
• Swagger UI tutorial
• SwaggerHub introduction and tutorial
• Swagger UI Demo
• Integrating Swagger UI with the rest of your docs
• Redocly tutorial -- authoring and publishing API docs with Redocly's command-line tools
• Redoc Community Edition Basic Demo

Buy me a coffee