Skip to main content

Docs Controller - Swagger (OpenAPI 3.0)

1. Swagger Documentation (OpenAPI): The Swagger documentation, based on the OpenAPI standard, is a standardized specification for describing APIs. It provides a more detailed look at the API, including precise technical information. The Swagger documentation is known for:

  • Technical Details: The Swagger documentation displays specific technical information, including HTTP methods, parameters, data schemas, status codes, and more.

  • Clear Data Schemas: Data schemas, which define the structure of request and response objects, are displayed in a clear manner, allowing developers to understand the structure of expected or returned data.

  • Examples and Validation: Swagger docs often provide request and response examples along with format validations, which helps developers build correctly.

  • Industry Standard: The Swagger format (OpenAPI) is widely recognized and used in the industry, which facilitates adoption and collaboration between development teams.

In short, the controller that displays both documentation (Redoc and Swagger) gives developers the flexibility to choose the approach that best fits their needs. The Redoc documentation provides an interactive and simplified overview, while the Swagger documentation provides extensive technical detail, allowing developers to choose the level of depth needed to interact effectively with an API.