OpenAPI: Difference between revisions

From Omnia
Jump to navigation Jump to search
m (Kenneth moved page OpenAPI Specification to OpenAPI)
No edit summary
 
Line 6: Line 6:
OpenAPI Specification (formerly Swagger Specification) is an API description format for REST APIs. An OpenAPI file allows you to describe your entire API, including:
OpenAPI Specification (formerly Swagger Specification) is an API description format for REST APIs. An OpenAPI file allows you to describe your entire API, including:


Available endpoints (/users) and operations on each endpoint (GET /users, POST /users)
* Available endpoints (/users) and operations on each endpoint (GET /users, POST /users)
Operation parameters Input and output for each operation
* Operation parameters Input and output for each operation
Authentication methods
* Authentication methods
Contact information, license, terms of use and other information.
* Contact information, license, terms of use and other information.

Latest revision as of 03:28, 14 May 2024

OpenAPI Specification

https://swagger.io/docs/specification/about/

What Is OpenAPI? OpenAPI Specification (formerly Swagger Specification) is an API description format for REST APIs. An OpenAPI file allows you to describe your entire API, including:

  • Available endpoints (/users) and operations on each endpoint (GET /users, POST /users)
  • Operation parameters Input and output for each operation
  • Authentication methods
  • Contact information, license, terms of use and other information.