Skip to main content

Documentation Swagger (OpenAPI) - JSON

GET 
/api/v2/reference/swagger.json

Swagger (OpenAPI): API Documentation Standardization

Swagger, currently called the OpenAPI Specification, is an open and widely used standard for describing APIs in a detailed and standardized way. It provides a way to document and define all the characteristics of an API, including endpoints, HTTP methods, parameters, data types, data schemas, sample requests and responses, status codes, and much more.

Key Features of Swagger (OpenAPI):

  1. Full API Description: Swagger allows you to describe all details of your API comprehensively. This includes available endpoints, supported HTTP methods (GET, POST, PUT, DELETE, etc.), input and output parameters, possible status codes, and much more.

  2. Standardization and Consistency: Swagger promotes standardization and consistency in API documentation, making it easier for developers to understand and use the API uniformly.

  3. Automatic Documentation Generation: Based on the Swagger (OpenAPI) specification, you can automatically generate API documentation in a variety of formats, including interactive HTML, Markdown, and other options.

  4. Request and Response Examples: Swagger allows you to include clear examples of how to construct requests to the API and how to interpret the responses. This helps developers understand how to correctly use the API.

  5. Data Validation: The Swagger specification allows you to define expected data schemas in requests and responses. This allows automatic data validation, helping to prevent errors and inconsistencies.

  6. Tools and Ecosystem: There are many tools and libraries that support the Swagger standard (OpenAPI), including documentation generators, spec validators, auto-generated HTTP clients, and more.

  7. Collaboration: The Swagger (OpenAPI) specification is plain text, which facilitates collaboration between development teams, allowing everyone to have a clear and unified understanding of the API.

  8. Support for Different Languages and Platforms: The Swagger (OpenAPI) standard is language and platform independent, which means you can use it in a variety of development scenarios.

In summary, Swagger (OpenAPI) provides a standardized and robust method for describing, documenting and sharing details of APIs. It is widely adopted in the software development industry to ensure that APIs are well documented, understandable and usable by developers from different experience levels.

Request​

Responses​

Loading...