Swagger

External

• https://swagger.io
• OpenAPI Swagger Specification https://swagger.io/specification/
• Tools and Integrations: https://swagger.io/tools/open-source/open-source-integrations/

Internal

• REST and Hypermedia
• OpenAPI
• API
• JAX-RS

Overview

Swagger is a set of open-source tools built around the OpenAPI specification that can help you design, build, document and consume REST APIs.

Tools

• Swagger Editor
• Swagger UI
• Swagger Codegen
• SwaggerHub
• Swagger Inflector
• Swagger Inspector

API Documentation

Process: https://www.infoq.com/presentations/doc-restful-api

API Documentation vs. Swagger-generated Specification File

In general, the terms "API Documentation" and the Swagger specification are used interchangeably.

Subjects

• Generating Swagger/OpenAPI Specification from Spring Code