Swagger

TODO linken naar verschillende decorators doorheen het project

Swagger is a framework used for documenting, and consuming RESTful APIs. The main components include:

• OpenAPI Specifications: A standardized format for describing APIs in a machine-readable format (JSON). This specification outlines the endpoints, request/response formats, authentication methods, and more.

• Swagger UI: A web-based interface that generates interactive API documentation from the OpenAPI Specification. Users can explore the API endpoints, see example requests and responses, and even make calls directly from the interface.

We use the @nestjs/swagger package to automatically generate a OpenAPI file for the swagger-ui to interpret.