Project 内に Swagger Document を同梱する方法

1 Swagger Editor で Swagger を書く

プロジェクト内の適当な箇所に Yaml を配置する

2 環境構築

$ npm i json-refs swagger-ui-dist --save

3 コマンド記述

サンプルは Makefile で

swagger:
    rm -rf public/swagger
    cp -R ./node_modules/swagger-ui-dist public/swagger
    sed -i -e 's/http:\/\/petstore\.swagger\.io\/v2\/swagger\.json/\.\/swagger.json/' public/swagger/index.html
    ./node_modules/.bin/json-refs resolve document/swagger/api.yml > public/swagger/swagger.json

上記例では、public/swagger フォルダに 展開しているので、上手くホスティングすれば、Swagger ドキュメントが確認できる。

備考

json-refs コマンドは yaml の json化だけでなく、$refをつかった 外部参照にも対応しているので便利