06 – Integrar Swagger / OpenAPI
Descripción
Documentar la API mediante OpenAPI 3 con Swagger UI usando springdoc-openapi. Evidencia obligatoria del video.
Owner sugerido: Dev D | Branch: feature/swagger-openapi | Depende de: #2 (closed)
Tareas
-
Agregar springdoc-openapi-starter-webmvc-ui(v2.6.0) alpom.xml. -
Crear OpenApiConfigenconfig/conOpenAPIbean: titleSIENEP API, description, versionv0.1.0, contacto. -
Configurar en application.yml:springdoc.api-docs.path: /v3/api-docs,springdoc.swagger-ui.path: /swagger-ui.html. -
Verificar acceso a /swagger-ui/index.html. -
Documentar URL de Swagger en README. -
Coordinar con Dev C (issue #11) para anotaciones @Tag,@Operation,@ApiResponseen controladores.
Commits sugeridos
build(swagger): agregar dependencia springdoc-openapi
feat(swagger): configurar metadatos de la api (title, version, contacto)
docs(readme): documentar acceso a swagger ui
Criterios de aceptación
-
/swagger-ui/index.htmlcarga sin errores. -
/v3/api-docsdevuelve JSON OpenAPI 3 válido. -
Metadatos visibles en la UI (title, version).
Referencia del curso: Módulo 2 – PDF 9 (Swagger/OpenAPI + Postman/Insomnia/Redocly)