OpenAPI

From NovaOrdis Knowledge Base
Jump to navigation Jump to search

External

Internal

Subjects

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

Media Types