OpenAPI逆引きメモ

必要に迫られたOpenAPI関連の逆引きメモになります

サンプルの複数記述

examples フィールドはOpenAPI Specification 3.0以降でのみ使用可能

paths:
  /your/path:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/YourRequestBodySchema'
            examples:
              example1:
                summary: サンプル1の説明
                value:
                  # ここにサンプル1のリクエストボディを記述
              example2:
                summary: サンプル2の説明
                value:
                  # ここにサンプル2のリクエストボディを記述

yamlをhtmlへ変換

DockerでRedocly CLIを使用してyamlをhtmlへ変換

docker run --rm -v "C:\.swagger:/spec" redocly/cli build-docs /spec/test_api.yaml -o /spec/test_api.html