Skip to content

0012. Swagger obligatorio en cada endpoint

Estado

Aceptada

Contexto

El backend necesita una fuente de verdad tipada de su API, tanto para navegar la documentación interactiva como para autogenerar tipos y una referencia de API sin mantenerla a mano.

Decisión

Cada endpoint debe llevar @ApiTags, @ApiOperation, @ApiResponse, @ApiProperty, @ApiBearerAuth.

Consecuencias

El spec OpenAPI sirve para autogenerar tipos y, desde esta tarea (camaroneras_docs), para generar la API Reference del sitio de documentación sin depender del criterio manual de un LLM para los ejemplos (ver paso 5-6 del plan).