OpenAPI

External

• OpenAPI 3.0 Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md
• OpenAPI 2.0 Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
• https://swagger.io/specification/
• Friendlier Specifications, more like an User Guide: https://swagger.io/docs/specification

Internal

• API
• Swagger
• OpenAPI Specification

OpenAPI Specification

OpenAPI Specification, or OAS, formerly Swagger Specification, is an API description format for REST APIs. An OpenAPI file allows you to describe the entire API, including:

• Available endpoints and operations on each endpoint.
• Input and output parameters for each operation.
• Authentication methods.
• Contact information, license, terms of use, etc.

OpenAPI Specification

Versions

OpenAPI 3.0.0

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md

OpenAPI 2.0

Also referred to as "Swagger".

Swagger 2.0 Example

Authentication and Authorization

Authentication and Authorization

Language Support

• Go