[解決済み] 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. JSON API - JSON APIは、レスポンスだけでなく、リソースの作成・更新も対象です。
2. JSend - シンプルで、おそらくあなたがすでにやっていることでしょう。
3. OData JSON プロトコル - 非常に複雑
4. HAL - ODataのようなものだが、目指しているのは HATEOAS のようなものです。

また、JSON APIの記述形式もあります。

• スワッガー
  • JSON スキーマ (swaggerで使用されていますが、単独で使用することもできます。）
• WADLをJSONに変換する
• RAML
• HAL なぜなら HATEOAS は、理論的には自己記述的である。