web-dev-qa-db-ja.com

Swaggerドキュメントから静的HTMLファイルを生成する方法は？

以下のyamlファイルを使用してSwaggerドキュメントを作成しました。

 api/swagger/swagger.yaml

今私は静的なhtmlドキュメントをその定義と共有したいのですが、それは swaggerプロジェクト で、HTMLの生成をサポートする予定はまったくないと述べられています。

Swaggerプロジェクトから静的HTMLファイルを生成するにはどうすればよいですか？

linuxswaggerapi-dochtml-generation
10
k0pernikus

私が考えることができる最も簡単な方法は Swagger Editor を使用することです：

  1. 移動： https://editor.swagger.io
  2. トップメニューバーの[ファイル]をクリックし、[ファイルのインポート]を選択します。
  3. インポート後、上部のメニューバーの[クライアントの生成]をクリックし、[HTML]または[HTML2]を選択して静的HTMLドキュメントを生成します

editor.swagger.ioは、generator.swagger.ioを使用してAPIクライアント、サーバースタブ、およびドキュメントを生成します。generator.swagger.ioは、オープンソースプロジェクト Swagger Codegen を利用しています。

7
William Cheng

静的adocファイルを生成できる swagger2markup-cli があります。

Javaランタイムがインストールされていることを確認します（私は `Java（TM）SEランタイム環境（ビルド1.8.0_111-b14））を使用しています）。

あなたは瓶を取り出します：

 wget https://jcenter.bintray.com/io/github/swagger2markup/swagger2markup-cli/1.1.0/swagger2markup-cli-1.1.0.jar

そして、あなたはそれを使って静的なadocを生成することができます：

Java -jar ~/your/path/swagger2markup-cli-1.1.0.jar  help convert  -i api/swagger/swagger.yaml --outputFile static-swagger

次に、そのadocファイルを html を使用してasciidoctorファイルに変換できます。

asciidoctor *.adoc

Ubuntuを使用しているため、次の方法でインストールする必要があります。

Sudo apt-get -qq install asciidoctor
3
k0pernikus
  1. ダウンロード https://github.com/swagger-api/swagger-ui -対象のフォルダーは " dist "
  2. Swagger JSONをdistフォルダーにコピーします
  3. Index.htmlを開き、ファイルの下部にあるタグ内のURLの値を./swagger.json（またはswagger jsonが呼び出されるもの）に変更します（ here を参照）
  4. オンラインでホスト！ （または、ローカルサーバーを起動して出力を表示します）。
2
Ismail Moghul