swagger.json を 静的html やPDFに変換するCircleCI 2.0 workflow
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 が用意されていたので簡単だ。
Author And Source
この問題について(swagger.json を 静的html やPDFに変換するCircleCI 2.0 workflow), 我々は、より多くの情報をここで見つけました https://qiita.com/nikushi/items/00e43405ac3c685aebf8著者帰属:元の著者の情報は、元のURLに含まれています。著作権は原作者に属する。
Content is automatically searched and collected through network algorithms . If there is a violation . Please contact us . We will adjust (correct author information ,or delete content ) as soon as possible .