Swagger 定義ファイルから そこそこいい感じの静的 REST API ドキュメント作成する - Witch on the Other Shore

REST API のドキュメンテーションはサービス開発における課題として認知されており、解決に向け近年さまざまな試みが行われています。OPEN API および Swagger はその有力な動きの1つです。 長いものには巻かれろ (?) ということで、今回は Swagger 定義ファイルをベースとした REST API ドキュメントの生成方法をまとめます。 結論 swagger2markup-cli と asciidoctor を組み合わせて HTML ファイルを生成するのがよさそうです。 課題の共有 Swggger 定義ファイルからドキュメントを生成する手順はいくつか存在します。 swagger-ui を利用する swagger-codegen で HTML を出力する swagger-ui はリッチで美しいドキュメントを提供してくれます。しかしインタラクティブな API ドキュメントが必

[kiririmode]

swaggerでいい感じのドキュメントを作成する