Versiones comparadas

Clave

  • Se ha añadido esta línea.
  • Se ha eliminado esta línea.
  • El formato se ha cambiado.

...

  • ¿Cómo puedo ver en local la documentación OpenAPI?

  • La documentación en formato JSON está siempre accesible en http://localhost:8080/api-docs
    Copia ese JSON a partir de la "{" es decir no copies las dos primeras líneas de comentarios "// lo que sea"
    Abre el editor abierto de Swagger.io https://editor-next.swagger.io/
    Pega en la parte de la izquierda tu JSON
    Se generará en la parte de la derecha la definición de la API

Para poder ver, en mi entorno local, cómo quedaría mi documentación OpenApi, no necesito añadir ninguna dependencia extra para levantar un frontal web que la lea. Por defecto, en las aplicaciones FundewebJS, el JSON que representa la documentación OpenAPI se encuentra en http://localhost:8080/api-docs.

Por tanto lo que tenemos que hacer es, acceder a esa URL y copiar el JSON resultante. Una vez copiado nos vamos a Swagger.io https://editor-next.swagger.io/ y pegamos en la parte izquierda nuestro JSON (deberemos quitar todos los comentarios "//" ya que de lo contrario no leerá bien el formato).

Una vez pegado, en la parte de la derecha veremos nuestra documentación en formato web.

...