SQL見るだけクエリ#326 一般的なAPI JSONの例

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

一般的なAPI JSONの例について解説してみようと思います。

一般的なAPI JSONの例

API連携において使用されるJSONの構造は、具体的なAPIやサービスによって異なりますが、 一般的にはいくつかの共通パターンがあります。以下に、一般的なAPI JSONの例を示します。

1. リストの取得（List Retrieval）

一般的なAPIでは、リスト形式でデータを取得することがあります。例えば、ユーザー一覧や製品一覧を取得する際のJSONは次のようになります。

{
  "users": [
    {"id": 1, "name": "Alice"},
    {"id": 2, "name": "Bob"},
    {"id": 3, "name": "Charlie"}
  ]
}

2. エンティティの取得（Entity Retrieval）

単一のエンティティを取得する場合のJSONは次のようになります。

{
  "user": {
    "id": 1,
    "name": "Alice",
    "email": "alice@example.com",
    "age": 28
  }
}

3. リクエストとレスポンス

APIリクエストやレスポンスでは、一般的には以下のような構造が使われます。

#リクエスト

{
  "method": "GET",
  "endpoint": "/users",
  "params": {
    "page": 1,
    "limit": 10
  }
}

#レスポンス

{
  "status": "success",
  "data": {
    "users": [
      {"id": 1, "name": "Alice"},
      {"id": 2, "name": "Bob"}
    ]
  }
}

4. エラーレスポンス

エラーが発生した場合のレスポンスは、通常以下のような構造を取ります。

{
  "status": "error",
  "message": "Invalid request. Missing required parameter."
}

5. ページネーション

大量のデータを取得する場合、ページネーションが行われることがあります。

{
  "page": 1,
  "per_page": 10,
  "total": 100,
  "data": [
    {"id": 1, "name": "Item 1"},
    {"id": 2, "name": "Item 2"},
    // ...
  ]
}

これらは一般的な例であり、APIが提供するサービスやデータの性格によって変わります。APIのドキュメンテーションを確認することで、特定のAPIが期待するJSON構造やエンドポイントの使い方を理解できます。