openapi guiダウンロード - openapi guiソースコードのダウンロード

openapi gui

その他のリソース

1.0.0

ダウンロード

Openapi-Gui

Openapi-Guiは、Openapiバージョン3.0.x JSON/YAML定義を作成および編集するためのGUIです。現在の形式では、Simple OpenAPI定義を開始して編集するためのツールとして最も便利です。インポートされたOpenAPI 2.0定義は、v3.0に自動的に変換されます。

以前のSwagger / Openapi 2.0のみのバージョンについては、こちらを参照してください。そのバージョンは現在、セキュリティの修正とは別に容認されていません。

このプロジェクトは当初、ダリル・クーンのヨードクターのフォークであり、ルビーで書かれたブランドン・ウェストのヨードクターに触発されました。プロジェクトの完全な履歴は、Githubで維持されています。

説明

それがどのように機能するか

既存のOpenAPI 2.0または3.0.xの定義を選択してアップロードするか、新しい定義を作成し、パス、操作、およびパラメーターの追加を開始します。既存の定義を使用すると、それは解析され、各パスを編集するためのフォーム、操作とパラメーターが作成されます。

既存の定義をロードすることで、既存の定義をロードすることができます?url=クエリパラメーターは、ロードする定義のURLである値を最初の開始ページに追加できます。 Dockerを使用する場合、 urlクエリパラメーターの値を%2fserveに設定して、Dockerコマンドラインに渡された定義をピックアップできます。

左側のメニューからアイテムをクリックして編集を開始します。「エクスポート」タブのいずれかを選択して、JSON/YAML出力をいつでも表示します。終了したら、出力をダウンロードしてローカルに保存するか、クリップボードをコピーします。 Openapi-Guiは一度に1つの定義のみを保存しますが、これはブラウザのローカルストレージにあります。 json/yaml出力をローカルに保存してください。

破壊的なアクションを実行する前に、Openapi-Guiは定義の現在の状態を保存します。他のすべての場合、手動で保存を選択することを忘れないでください。

テクノロジー

Openapi-Guiは、CSSのVue.JS、JQuery、Bulmaを含む多くのJavaScriptフレームワークを使用して、完全にクライアント側を実行します。

アプリを稼働させるには、GitHubページのライブバージョンを参照するだけで、クローンをGitHubページに展開するか、下のボタンを使用してHerokuに展開するか、Repoをクローンしてindex.htmlでブラウザをポイントするか、自分でホストすることはできません。こちらの技術情報。

openapi-gui Embedded Webサーバーを使用する場合（つまり、独自のWebサーバーを実行している場合はそうではありません）、node.jsモジュールnpm install必要があります。

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

Dockerで走っています

ローカルノード開発環境がない場合、またはDockerコンテナでOpenapi-Guiを実行したい場合は、いくつかの簡単な手順を実行できます。

リポジトリをクローンします。
docker build -t mermade/openapi-gui . Dockerイメージを構築するには（ mermade/openapi-gui ）
Run docker run --name openapi-gui -p 8080:3000 -d mermade/openapi-guiポート8080でサーバーを実行します。
お気に入りのブラウザでhttp://localhost:8080に移動します。
完了したら、 docker stop openapi-gui && docker rm openapi-guiを実行してサーバーをシャットダウンします

または、事前に構築されたDocker画像を引くことができます。