OpenAPI Specification

Swagger と OpenAPI Initiative で分派しているのでわかりにくいのだけど、２つドキュメントがあるっぽい。

• Swagger版: OpenAPI Specification - Version 3.0.3 | Swagger
• OAI版: OpenAPI Specification v3.1.0 (Repo: OAI/OpenAPI-Specification)

redoc x Docker Compose

OpenAPI定義ファイルからドキュメントを生成するツール、Redocly/redocを docker compose で使う場合。

  redoc:
    image: redocly/redoc
    ports:
      - 8081:80
    volumes:
      - ./swagger.yml:/usr/share/nginx/html/swagger.yml
    environment:
      SPEC_URL: swagger.yml

swagger-merger + ReDoc + DockerでAPIドキュメントを作る - Qiita

swagger-ui の場合

同URLで紹介されているように swagger-ui を使う場合はこう。

version: "3"

services:
  swagger-ui:
    image: swaggerapi/swagger-ui
    ports:
      - 8080:8080
    volumes:
      - ./swagger.yml:/usr/share/nginx/html/swagger.yml
    environment:
      API_URL: swagger.yml

ただ最近の情報を追う限りは、swagger-ui よりも redoc のほうがトレンドっぽい空気を感じる。