SQL見るだけクエリ#323 OpenAPIとは

記入日：2023-11-27　編集日：2023-11-27

OpenAPIについて解説してみようと思います。

OpenAPIとは

OpenAPIは、RESTfulなAPIを設計、ドキュメント化、利用しやすくするための仕様およびツールのセットです。APIの機能や構造を定義し、ドキュメントを自動生成し、クライアントコードを生成するために使用されます。OpenAPIはオープンで標準的な形式でAPIを記述するため、開発者コミュニティや利用者との相互運用性を向上させます。

OpenAPI Specificationの基本的な記述方法

OpenAPI Specificationは主にJSONまたはYAML形式で記述されます。以下は基本的な構造の例です：

openapi: 3.0.0

info:
  title: Your API Title
  version: 1.0.0

paths:
  /endpoint:
    get:
      summary: Description of the operation
      responses:
        '200':
          description: Successful response

主要な要素：

• openapi: 使用するOpenAPI Specificationのバージョンを指定します。
• info: APIに関する基本情報（タイトル、バージョンなど）を指定します。
• paths: 利用可能なエンドポイントとそれに対するオペレーションを指定します。

具体例：売上データAPIのスキーマ

以下は、売上データAPIのスキーマの具体例です。

{
  "openapi": "3.0.0",

  "info": {
    "title": "Sales Data API",
    "description": "Provides access to sales data for analysis.",
    "version": "1.0.0"
  },

  "servers": [
    {
      "url": "https://sales-data-api.example.com"
    }
  ],

  "paths": {
    "/sales": {
      "get": {
        "description": "Retrieve sales data",
        "operationId": "GetSalesData",
        "parameters": [
          {
            "name": "start_date",
            "in": "query",
            "description": "Start date for sales data retrieval",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "end_date",
            "in": "query",
            "description": "End date for sales data retrieval",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful sales data retrieval",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "date": {
                        "type": "string",
                        "format": "date"
                      },
                      "product": {
                        "type": "string"
                      },
                      "revenue": {
                        "type": "number"
                      },
                      "quantity": {
                        "type": "integer"
                      }
                    }
                  }
                },
                "example": [
                  {
                    "date": "2023-01-01",
                    "product": "Product A",
                    "revenue": 1000.0,
                    "quantity": 50
                  },
                  {
                    "date": "2023-01-02",
                    "product": "Product B",
                    "revenue": 1500.0,
                    "quantity": 30
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

この例では、APIの基本情報、エンドポイント、オペレーション、パラメータ、レスポンスが詳細に定義されています。これにより、開発者や利用者がAPIを理解し、効果的に利用できるようになります。