swagger-uiとredocをローカルで手早く動かす方法


Swagger, OpenAPIのドキュメント表示で一番使われてるやつ1 を手軽に手元で動かしたい時

TL;DR

# docker-compose.yml取ってくる
wget -O docker-compose.yml https://git.io/fjEfu
# 起動
docker-compose up -d
# swagger-ui開く
open http://localhost:8080
# redoc開く
open http://localhost:8081

手元にあるopenapi.jsonを読み込ませたい時

# サンプルのopenapi.jsonをDLする
wget https://generator3.swagger.io/openapi.json

docker-compose.ymlと同じディレクトリにopenapi.jsonがある場合、こんな風に編集すればOK

    environment:
--      SPEC_URL: https://generator3.swagger.io/openapi.json
++      SPEC_URL: /openapi.json
++    volumes:
++      -  ./openapi.json:/usr/share/nginx/html/openapi.json
  • nginxのデフォルトの公開ディレクトリ/usr/share/nginx/html にopenapi.jsonがマウントされるようにしただけ

  1. DL数見る限りこの2つ以外は、飛沫状態だった