APIのデータフォーマット

Page content

APIを使って送られるデータのフォーマットは、JSON（JavaScript Object Notation）が最も一般的で主流です。

💻 主流のデータフォーマット

1. JSON (JavaScript Object Notation)

  • 特徴: シンプルで軽量、人間にとっても機械にとっても読み書きしやすいテキストベースのデータフォーマットです。
  • 採用理由: プログラミング言語との親和性が高く、多くのWeb API（特にREST API）のレスポンス形式として広く採用されています。複雑なデータ構造も表現可能です。

🛠 その他のデータフォーマット

JSONの他に、以下のようなデータフォーマットが利用されることもあります。

2. XML (Extensible Markup Language)

  • 特徴: タグを使ってデータの構造を記述する形式です。
  • 採用例: SOAP（Simple Object Access Protocol）などの古いタイプのWebサービスや、特定の業界・システムでの連携に利用されることがあります。JSONよりも冗長になりがちですが、厳密な構造定義に適しています。

3. CSV (Comma Separated Values)

  • 特徴: カンマなどで区切られたテキスト形式のデータです。
  • 採用例: 大量の表形式データをやり取りする場合や、シンプルなデータ連携に使用されることがあります。構造化されたデータ（ネストされたデータ）の表現には不向きです。

4. YAML (YAML Ain’t Markup Language)

  • 特徴: 人間が読みやすいことを重視したデータ形式です。インデントで構造を表現します。
  • 採用例: 設定ファイルなどでよく使われますが、APIのデータ転送形式として採用されることもあります。

🔑 確認事項

実際に利用するAPIのデータフォーマットは、そのAPIの公式ドキュメントで確認する必要があります。ほとんどのAPIでは、リクエストのヘッダーなどでデータの形式を指定したり、レスポンスのContent-Typeで返されるデータ形式が示されます。