More than 5 years have passed since last update.

SwaggerファイルをHTMLへ変換する

Last updated at 2017-02-04Posted at 2017-02-04

目的

yaml形式で作成したswaggerファイルをドキュメントとして共有するためにHTML形式に変換します。

swagger2markup-cli
https://github.com/Swagger2Markup/swagger2markup-cli
をクローンしてビルドします。

$ git clone https://github.com/Swagger2Markup/swagger2markup-cli.git 
$ ./gradlew jar

build/libsディレクトリにjarが出力されます。
以下のように実行します。

$ java -jar swagger2markup-cli-1.2.1-SNAPSHOT.jar convert -i swagger.yaml -f swagger

-i swaggerファイル名
-f 出力ファイル名

Asciidoctorをインストールします。
http://asciidoctor.org/

$ gem install asciidoctor

以下のように実行します。

$ asciidoctor -a toc=left swagger.adoc

-a toc=left
を付けるとサイドバーに目次を付けることができます。

Swagger Editorのサンプルswaggerファイルを変換すると以下のようなHTMLが生成できます。