swagger.json を ドキュメント化して参照したいけどSwagger UIは使わない(運用したくない)。S3などで静的なHTMLサイトとして配信して楽したい。
は circle yml のexample。
CircleCIのビルドパイプライン(workflow)でswagger.json -> asciidoc -> html -> S3 upload の順にビルドする流れ。git push してほったらかすといい感じドキュメントが仕上がる。
- swagger.json -> asciidoc は Swagger2Markup-Cli で変換
- asciidoc -> html は asciidoctor で変換
- aws s3 コマンドでupload (未実装)
htmlではなくPDFなど他のフォーマットで生成するときは asciidoctor の引数を変更すればOKそう。
それぞれ dockerimage が用意されていたので簡単だ。