7.4 OpenAPI/Swagger

7.4.1 OpenAPI Specificationとは

REST APIの標準的な記述フォーマット。YAML/JSONで定義し、ドキュメント生成やコード生成が可能。

7.4.2 基本構造

openapi: 3.0.0
info:
  title: サンプルAPI
  version: 1.0.0
paths:
  /users:
    get:
      summary: ユーザー一覧取得
      responses:
        '200':
          description: 成功
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'