Saltar al contenido

¿Cómo generar un archivo YAML de OpenAPI 3.0 a partir de la API Spring REST existente?

Deseamos compartirte la mejor solución que encontramos on line. Nosotros queremos que te sea útil y si puedes compartir alguna mejora hazlo libremente.

Solución:

hemos usado últimamente springdoc-openapi biblioteca java. Ayuda a automatizar la generación de documentación API utilizando proyectos de arranque de primavera.

Se despliega automáticamente swagger-ui a una aplicación Spring-Boot La documentación estará disponible en formato HTML, usando el oficial [swagger-ui jars]:

La página de la interfaz de usuario de Swagger debería estar disponible en http://server:port/context-path/swagger-ui.html y la descripción de OpenAPI estará disponible en la siguiente URL para el formato json: http://server:port/context-path/v3/api-docs

  • servidor: El nombre del servidor o IP
  • puerto: El puerto del servidor
  • context-path: la ruta de contexto de la aplicación

La documentación también puede estar disponible en formato yaml, en la siguiente ruta: /v3/api-docs.yml. Agregue la biblioteca a la lista de dependencias de su proyecto (no se necesita configuración adicional)

 
      org.springdoc
      springdoc-openapi-ui
      1.2.3
  

¡Haz clic para puntuar esta entrada!
(Votos: 0 Promedio: 0)



Utiliza Nuestro Buscador

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *