Repolode
Enviar
swagger-api

swagger-api/swagger-core

Biblioteca Java que genera especificaciones OpenAPI a partir de anotaciones del código y API REST de JAX-RS, con compatibilidad con OpenAPI 3.x.

Ver en GitHubSitio web
Estrellas
7,535
Forks
2,255
Issues abiertos
219
Último commit
anteayer

¿Qué es?

Swagger Core es la implementación de Java de la especificación OpenAPI. Lee las anotaciones y las clases de recursos REST de una aplicación Java, y genera un documento OpenAPI que describe los endpoints, los parámetros, los cuerpos de las solicitudes y los modelos de respuesta. Después, herramientas como Swagger UI pueden mostrarlo como documentación interactiva de la API.

El proyecto está dirigido a aplicaciones JAX-RS 2 y ofrece conjuntos de artefactos paralelos para los espacios de nombres javax y Jakarta. Desde la versión 2.2.0, es compatible con OpenAPI 3.1; la línea 1.x anterior cubre OpenAPI 2.0. También ofrece un artefacto BOM para gestionar las versiones de los módulos individuales en compilaciones de Maven y Gradle.

El repositorio es una compilación multi-módulo de Maven que requiere Java 11 o posterior. Los ejemplos de integración se trasladaron a un repositorio independiente, swagger-samples.

Funciones clave

  • 01Genera documentos OpenAPI 3.x a partir de anotaciones Java y recursos JAX-RS.
  • 02Es compatible con artefactos para los espacios de nombres javax y Jakarta.
  • 03Ofrece compatibilidad con OpenAPI 3.1 desde la versión 2.2.0.
  • 04Incluye un BOM para mantener versiones coherentes de las dependencias en Maven y Gradle.

Casos de uso

  • Documentar una API REST de Java generando su especificación OpenAPI a partir del código.
  • Añadir documentación interactiva de la API a un servicio JAX-RS.
  • Migrar un servicio Java del espacio de nombres javax al de Jakarta y conservar la documentación de la API.

Antes de usarlo

  • Está dirigido a las API de Java y JAX-RS 2, por lo que no es adecuado para otras tecnologías.

Temas

#openapi#swagger#rest-api#java#api-documentation#jax-rs#hacktoberfest#open-source#openapi-specification#openapi3

Preguntas frecuentes

¿Qué es swagger-core?
Biblioteca Java que genera especificaciones OpenAPI a partir de anotaciones del código y API REST de JAX-RS, con compatibilidad con OpenAPI 3.x. Swagger Core es la implementación de Java de la especificación OpenAPI. Lee las anotaciones y las clases de recursos REST de una aplicación Java, y genera un documento OpenAPI que describe los endpoints, los parámetros, los cuerpos de las solicitudes y los modelos de respuesta. Después, herramientas como Swagger UI pueden mostrarlo como documentación interactiva de la API.
¿swagger-core es gratuito? ¿Qué licencia tiene?
swagger-core es open source bajo la licencia Apache-2.0. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿swagger-core sigue mantenido?
Mantenimiento activo. El último commit de swagger-core fue el 5 nov 2026.
¿Para qué puedo usar swagger-core?
Documentar una API REST de Java generando su especificación OpenAPI a partir del código. Añadir documentación interactiva de la API a un servicio JAX-RS. Migrar un servicio Java del espacio de nombres javax al de Jakarta y conservar la documentación de la API.
¿Dónde consigo swagger-core?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/swagger-api/swagger-core

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

Proyectos relacionados