Taker's インフラ関連技術調査ログ

インフラ関連についての調査メモです。

Editing Swagger UIを使ったAPI仕様書の閲覧

はじめに

swagger.jsonまたはswagger.yamlによって書かれた
ドキュメントをHTMLで参照するには Swagger UI を使用する

Swagger UI Serverの準備

ダウンロード

任意のディレクトリに移動し、swagger-ui.gitをチェックアウトする

git clone https://github.com/swagger-api/swagger-ui.git
cd swagger-ui/

Swaggerファイルのコピー

swagger-ui自身でファイルをサーブできるよう
swagger.yamlをdistにコピーする
Swager-UIから参照可能な場所においてあれば特にこれは必須ではない

cp -pi swagger.yaml ./dist/

Dockerで起動

docker build -t swagger-ui-builder .
docker run -p 127.0.0.1:8080:8080 swagger-ui-builder

アクセス

ブラウザでアクセスする

http://localhost:8080`

URL入力欄に以下を入力

http://localhost:8080/swagger.yaml

上手く行けば表示されるはず

参考

デフォルトでPetstoreのDemoサイトのURLが設定されててしかも動かないので変更したい場合は下記を参考。

/* Responsive: yes */