openapi gui
1.0.0
OpenAPI-GUI ist eine GUI zum Erstellen und Bearbeiten von OpenAPI-Version 3.0.x JSON/YAML-Definitionen. In seiner aktuellen Form ist es als Werkzeug zum Starten und Bearbeiten einfacher OpenAPI -Definitionen am nützlichsten. Importierte OpenAPI 2.0 -Definitionen werden automatisch in v3.0 konvertiert.
Für die vorherige Version von Swagger / OpenAPI 2.0 finden Sie hier. Diese Version ist derzeit abgesehen von Sicherheitsbehebungen.
Dieses Projekt war zunächst eine Gabel von Daryl Kuhns Iodoctor, die wiederum von Iodoctor von Brandon West inspiriert wurde, der in Ruby geschrieben wurde. Die vollständige Geschichte des Projekts wird auf GitHub aufrechterhalten.
Wählen Sie eine vorhandene OpenAPI 2.0 oder 3.0.x -Definition zum Hochladen oder erstellen Sie eine neue Definition und fügen Sie Pfade, Operationen und Parameter hinzu. Wenn eine vorhandene Definition verwendet wird, wird sie analysiert und Formulare für die Bearbeitung aller Pfad, Betrieb und Parameter werden erstellt.
Sie können eine vorhandene Definition laden, indem Sie einen Parameter ?url= Abfrage an die Anfangsstartseite anhängen, wobei der Wert die URL für die Definition ist, die Sie laden möchten. Bei der Verwendung von Docker können Sie den Wert des Parameters von url -Abfrage auf %2fserve festlegen, um die Definition, die Sie in der Docker -Befehlszeile übergeben haben, aufzunehmen.
Klicken Sie aus dem Menü links auf ein Element, um mit der Bearbeitung zu beginnen. Zeigen Sie die JSON/YAML -Ausgabe jederzeit an, indem Sie eine der Registerkarten "Exportieren" auswählen. Laden Sie nach Abschluss die Ausgabe herunter, um sie lokal zu speichern, oder kopieren Sie sie in Ihre Zwischenablage. OpenAPI-GUI speichert jeweils nur eine Definition, und dies befindet sich in der lokalen Storage Ihres Browsers. Stellen Sie sicher, dass Sie Ihre JSON/YAML -Ausgabe lokal speichern.
Vor der Ausführung einer zerstörerischen Handlung rettet OpenAPI-Gui den aktuellen Zustand der Definition. Zu allen anderen Zeiten müssen Sie daran denken, manuell zu speichern.
OpenAPI-GUI wird vollständig clientseitig mit einer Reihe von JavaScript-Frameworks ausgeführt, darunter Vue.js, JQuery und Bulma für CSS.
Um die App aufzunehmen und auf Github -Seiten nur zur Live -Version zu stöbern, stellen Sie einen Klon auf Github -Seiten ein, stellen Sie mit dem folgenden Button in Heroku bereit, oder klonen Sie das Repo und richten Sie einen Browser auf index.html oder Host selbst - können nicht einfacher sein. Weitere technische Informationen hier.
Sie müssen nur npm install wenn Sie den eingebetteten Webserver openapi-gui verwenden möchten (dh nicht, wenn Sie Ihr eigenes Webserver ausführen), andernfalls sind sie nur für PAAS-Bereitstellungen vorhanden.
-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
Wenn Sie keine lokale Notenentwicklungsumgebung haben oder OpenAPI-Gui in einem Docker-Container bevorzugen, können Sie einige einfache Schritte ausführen:
docker build -t mermade/openapi-gui . Um das Docker-Bild zu erstellen ( mermade/openapi-gui )docker run --name openapi-gui -p 8080:3000 -d mermade/openapi-gui um den Server auf Port 8080 auszuführen.http://localhost:8080 .docker stop openapi-gui && docker rm openapi-gui ausführenOder Sie können das vorgefertigte Docker-Bild ziehen:
docker pull mermade/openapi-gui$ref s in sich geschlossen werden. Dies wird wahrscheinlich bald gelöst (ho-ho) .
