JSON API レスポンス形式に標準はありますか? 質問する

JSON API レスポンス形式に標準はありますか? 質問する

API からの JSON 応答を構造化するための標準またはベスト プラクティスはありますか? 明らかに、アプリケーションごとにデータは異なるため、私が関心があるのはそれではなく、いわゆる「応答の定型文」です。私が意味する例を次に示します。

リクエストが成功しました:

{
  "success": true,
  "payload": {
    /* Application-specific data would go here. */
  }
}

失敗したリクエスト:

{
  "success": false,
  "payload": {
    /* Application-specific data would go here. */
  },
  "error": {
    "code": 123,
    "message": "An error occurred!"
  }
}

ベストアンサー1

はい、いくつかの標準が出現しています (標準の定義には多少の自由がありますが)。

  1. JSON API- JSON API は、応答だけでなく、リソースの作成と更新もカバーします。
  2. JSend- シンプルで、おそらくすでにやっていることだと思います。
  3. OData JSON プロトコル- とても難しい。
  4. ハル- ODataに似ているが、ヘイトアスのように。

JSON API 記述形式もあります:

おすすめ記事