Swagger

External

• https://swagger.io
• OpenAPI Swagger Specification https://swagger.io/specification/
• Tools and Integrations: https://swagger.io/tools/open-source/open-source-integrations/
• Build, Document, and Deploy Your API with Swagger, Amazon API Gateway and Lambda https://swagger.io/blog/api-development/swagger-amazon-api-gateway-and-lambda/

Internal

• REST and Hypermedia
• OpenAPI, OpenAPI Specification
• API
• JAX-RS
• RAML
• json:api

Overview

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

Concepts

Swagger Concepts

Tools

• Swagger API Tools

• Swagger Editor
• Swagger UI
• Swagger Codegen
• SwaggerHub
• Swagger Inflector
• Swagger Inspector
• Amazon API Gateway Importer

API Documentation

API Documentation

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