OpenAPI: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
Line 35: Line 35:


=Media Types=
=Media Types=
=Authentication and Authorization=
{{External|https://swagger.io/docs/specification/authentication/bearer-authentication/}}
==Basic Authentication==
==API Keys==
==Bearer Authentication==
==OAuth 2.0==
==OpenID Connect Discovery==
==Cookie Authentication==

Revision as of 16:47, 2 November 2023

External

Internal

Overview

OpenAPI Specification

OpenAPI Specification (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 2.0

Also referred to as "Swagger".

Swagger 2.0 Example

OpenAPI 3.0

Media Types

Authentication and Authorization

https://swagger.io/docs/specification/authentication/bearer-authentication/

Basic Authentication

API Keys

Bearer Authentication

OAuth 2.0

OpenID Connect Discovery

Cookie Authentication