Repolode
springdoc

springdoc/springdoc-openapi

Genera documentación OpenAPI 3 y páginas de Swagger UI o Scalar para aplicaciones Spring Boot al inspeccionar los controladores en tiempo de ejecución.

Alternativa open source a:SpringFox

Estrellas
3,746
Forks
612
Issues abiertos
3
Último commit
hace 15 horas

¿Qué es?

springdoc-openapi es una biblioteca Java para aplicaciones Spring Boot que inspecciona en tiempo de ejecución los controladores, la configuración, las anotaciones de validación y las restricciones de Bean Validation. Genera una descripción OpenAPI 3, disponible en JSON y YAML, junto con una página interactiva de Swagger UI o Scalar. Basta con añadir una dependencia starter para empezar, sin necesidad de configuración adicional.

La biblioteca es compatible con Spring Web MVC y Spring WebFlux, incluidos los endpoints funcionales, y se integra con Spring Security, OAuth 2, Spring Data REST, Spring HATEOAS y Actuator. También admite Kotlin, Groovy y Javadoc, y puede exponer una API como herramientas para agentes de IA mediante MCP. Los plugins de Maven y Gradle pueden generar la descripción durante la compilación, y se admiten las imágenes nativas de GraalVM.

El proyecto está dirigido a Spring Boot 4.x en Java 17 o posterior. La línea 2.x se mantiene para Spring Boot 3, y la versión 1.x ya no cuenta con soporte de código abierto.

Funciones clave

  • 01Genera descripciones OpenAPI 3 en JSON y YAML en tiempo de ejecución a partir del código de Spring Boot.
  • 02Ofrece páginas de Swagger UI o Scalar para explorar la API.
  • 03Es compatible con Spring Web MVC, WebFlux y los endpoints funcionales.
  • 04Se integra con Spring Security, OAuth 2, Spring Data REST y HATEOAS.
  • 05Lee anotaciones de Bean Validation como @NotNull, @Min, @Max y @Size.
  • 06Incluye plugins de Maven y Gradle para generar la descripción durante la compilación.

Casos de uso

  • Documentar una API REST creada con Spring Boot sin escribir el archivo OpenAPI manualmente.
  • Ofrecer a los equipos de frontend o externos una página interactiva para probar los endpoints.
  • Exponer una API de Spring como herramientas para agentes de IA mediante MCP.
  • Generar un archivo OpenAPI durante la compilación para crear código cliente o comprobar contratos.

En colecciones

Temas

Preguntas frecuentes

¿Qué es springdoc-openapi?
Genera documentación OpenAPI 3 y páginas de Swagger UI o Scalar para aplicaciones Spring Boot al inspeccionar los controladores en tiempo de ejecución. springdoc-openapi es una biblioteca Java para aplicaciones Spring Boot que inspecciona en tiempo de ejecución los controladores, la configuración, las anotaciones de validación y las restricciones de Bean Validation. Genera una descripción OpenAPI 3, disponible en JSON y YAML, junto con una página interactiva de Swagger UI o Scalar. Basta con añadir una dependencia starter para empezar, sin necesidad de configuración adicional.
¿springdoc-openapi es gratuito? ¿Qué licencia tiene?
springdoc-openapi es open source bajo la licencia Apache-2.0. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿springdoc-openapi sigue mantenido?
Mantenimiento activo. El último commit de springdoc-openapi fue el 6 nov 2026.
¿Para qué puedo usar springdoc-openapi?
Documentar una API REST creada con Spring Boot sin escribir el archivo OpenAPI manualmente. Ofrecer a los equipos de frontend o externos una página interactiva para probar los endpoints. Exponer una API de Spring como herramientas para agentes de IA mediante MCP. Generar un archivo OpenAPI durante la compilación para crear código cliente o comprobar contratos.
¿Dónde consigo springdoc-openapi?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/springdoc/springdoc-openapi

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados