2016-11-03 13 views
4

私は下yamlファイルと闊歩のマニュアルを作成しました:今、私はそのdefintionで静的なHTMLドキュメントを共有したい、まだそれは、彼らがサポートする予定がないことを、swagger project上で述べたスワッガーのドキュメントから静的なhtmlファイルを生成するには?

api/swagger/swagger.yaml 

htmlの生成。

スワッガープロジェクトからスタティックhtmlファイルを生成するにはどうすればよいですか?

答えて

1

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

Javaランタイムがインストールされていることを確認してください。 (私は `Java(TM)SEランタイム環境(ビルド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 

そして、あなたは経由での静的adocを生成することができます:ADOCファイルは、その後asciidoctor経由htmlファイルに変換することができることを

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

asciidoctor *.adoc 

次のようにインストールする必要があります。で

sudo apt-get -qq install asciidoctor 
3

私は考えることができる最も簡単な方法は、 "ファイル" にhttps://editor.swagger.io

  • クリックしSWAGGERエディタ(https://editor.swagger.io

    1. Go]を使用することです:私は経由して私ができる、Ubuntuのを使用しています"インポートファイル"
    2. インポート後、トップメニューバーの "Generate Client"をクリックし、 "HTML"または "HTML2"を選択して静的HTMLドキュメントを生成します

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

  • 関連する問題