OpenAPI: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
No edit summary
 
(22 intermediate revisions by the same user not shown)
Line 1: Line 1:
=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=
=Internal=
* [[API#Subjects|API]]
* [[API#Subjects|API]]
* [[Swagger]]
* [[Swagger]]
* [[OpenAPI Specification]]
* [[OpenAPI Specification]]


=Overview=
=Subjects=
 
* [[OpenAPI Specification#Overview|OpenAPI Specification (OAS)]]
=OpenAPI Specification=
* <span id='Authentication_and_Authorization'></span>[[OpenAPI Authentication and Authorization]]
 
* [[OpenAPI_Specification_Path#Operation_Declaration_and_Implementation_Examples|OpenAPI Operation Declaration and Implementation Examples]]
OpenAPI Specification (formerly Swagger Specification) is an API description format for REST APIs. An OpenAPI file allows you to describe the entire API, including:
* [[OpenAPI_Code_Generators#Overview|OpenAPI Code Generators]]
* Available endpoints and operations on each endpoint.
* [[Swagger 2.0 Example]]
* Input and output parameters for each operation.
* Authentication methods.
* Contact information, license, terms of use, etc.
 
{{Internal|OpenAPI Specification|OpenAPI Specification}}
 
=Versions=
 
==OpenAPI 2.0==
 
Also referred to as "Swagger".
 
{{Internal|Swagger 2.0 Example|Swagger 2.0 Example}}
 
==OpenAPI 3.0==
 
=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==

Latest revision as of 23:11, 8 April 2024

Internal

Subjects

Retrieved from "https://kb.novaordis.com/index.php?title=OpenAPI&oldid=109182"