23

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

api/swagger/swagger.yaml

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

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

4

5 に答える 5

18

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

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

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

于 2016-11-04T09:07:23.270 に答える
4

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

Java ランタイムがインストールされていることを確認します。(私は使用していますJava(TM) SE Runtime Environment (build 1.8.0_111-b14))。

jar をフェッチします。

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

そして、次の方法で a static を生成できますadoc

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

htmlその adoc ファイルは、次の方法でファイルに変換できasciidoctorます。

asciidoctor *.adoc

私はUbuntuを使用しているので、インストールする必要があるかもしれません。

sudo apt-get -qq install asciidoctor
于 2016-11-03T16:50:40.203 に答える