openapi gui

Openapi-gui

Openapi-Gui es una GUI para crear y editar definiciones de OpenAPI Version 3.0.X JSON/YAML. En su forma actual, es más útil como herramienta para comenzar y editar definiciones simples de OpenAPI. Las definiciones importadas de OpenAPI 2.0 se convierten automáticamente en v3.0.

Para la versión anterior de Swagger / OpenAPI 2.0, consulte aquí. Esa versión actualmente no se mantiene aparte de las correcciones de seguridad.

Este proyecto fue inicialmente una bifurcación del yodoctor de Daryl Kuhn, que a su vez fue inspirado en yodoctor por Brandon West, que fue escrito en Ruby. La historia completa del proyecto se mantiene en GitHub.

Descripción

Cómo funciona

Seleccione una definición existente de OpenAPI 2.0 o 3.0.X para cargar, o cree una nueva definición y comience a agregar rutas, operaciones y parámetros. Cuando se usa una definición existente, se analiza y se creará formularios para editar cada ruta, operación y parámetro.

Puede cargar una definición existente agregando un parámetro de consulta ?url= Al usar Docker, puede establecer el valor del parámetro de consulta url en %2fserve para recoger la definición que pasó en la línea de comandos de Docker.

Haga clic en un elemento del menú de la izquierda para comenzar a editar. Vea la salida JSON/YAML en cualquier momento seleccionando una de las pestañas "Exportar". Cuando termine, descargue la salida para guardarlo localmente o copie su portapapeles. Openapi-Gui solo almacena una definición a la vez, y esto está en el almacenamiento local de su navegador. Asegúrese de guardar su salida JSON/YAML localmente.

Antes de realizar una acción destructiva, Openapi-Gui salva el estado actual de la definición. En todas las otras veces, debe recordar seleccionar guardar manualmente.

Tecnología

Openapi-Gui se ejecuta completamente del lado del cliente utilizando varios marcos de JavaScript, incluidos Vue.js, JQuery y Bulma para CSS.

Para que la aplicación se ejecute solo navegue a la versión en vivo en las páginas de GitHub, implementa un clon en las páginas de GitHub, despliegue en Heroku usando el botón a continuación, o clona el repositorio y apunte un navegador en index.html o aloje usted mismo, no podría ser más simple. Más información técnica aquí.

Solo necesita npm install los módulos Node.js si desea usar el servidor web incrustado openapi-gui (es decir, no si está ejecutando su propio servidor web), de lo contrario solo están allí para las implementaciones de PaaS.

Opciones de CLI

 -d, --definition    serve the given OAS definition
-l, --launch        start a web-browser pointing to the GUI
-p, --port          specify the port to run on, defaults to $PORT or 3000
-w, --write         enable writing back to the source definition

Corriendo con Docker

Si no tiene un entorno de desarrollo de nodos local, o si prefiere ejecutar OpenApi-Gui en un contenedor Docker, puede hacer con algunos pasos simples:

1. Clon el repositorio.
2. Ejecutar docker build -t mermade/openapi-gui . Para construir la imagen Docker ( mermade/openapi-gui )
3. Ejecutar docker run --name openapi-gui -p 8080:3000 -d mermade/openapi-gui para ejecutar el servidor en el puerto 8080.
4. Navegue a http://localhost:8080 en su navegador favorito.
5. Cuando haya terminado, apague el servidor ejecutando docker stop openapi-gui && docker rm openapi-gui

O puede extraer la imagen de Docker preconstruida:

• docker pull mermade/openapi-gui

Limitaciones

• OpenApi-GUI eliminará los parámetros compartidos.
• La definición debe ser autónoma sin $ref externas. Es probable que esto se resuelva (Ho-Ho) pronto .
• La edición de un esquema de respuesta / ejemplo / cuerpo lo deseará.
• Openapi-Gui no siempre preservará las extensiones de proveedores, por ejemplo, si se elimina y recrea un parámetro.
• Openapi-Gui no preservará los comentarios de las definiciones importadas en formato YAML.

HACER

• Consulte la lista TODO y el estado actual del soporte de especificaciones OpenAPI 3.0.