コンテンツへスキップ
uencoder

JSON:API

JSON:API は REST API のレスポンス形式仕様である。リソースオブジェクト、リレーション、ページネーション、エラーを標準化し、API 設計の分断を減らす。

目的

REST API に統一されたレスポンス構造を与え、クライアントがリソース・リレーション・エラーを汎用的に扱えるようにする。

メカニズム

レスポンスは data(リソースオブジェクトの配列/オブジェクト)、included(サイドロードされた関連リソース)、meta、errors を含む。リソースオブジェクトは id、type、attributes、relationships を持ち、リレーションは links か data を参照する。

ユースケース

  • REST API レスポンスの標準化
  • フロント・バックエンドのデータ契約
  • ページネーションと複合ロード

関連ツール

References