REST APIの応答にはどのような方法がありますか？

Question

REST APIの応答構造とレイアウトのベストプラクティスは何ですか？ scrathの

例：

成功応答：

{ 
    "status": "success", 
    "data": # some data here 
} 

失敗応答：

{ 
    "status": "fail", 
    "data": { 
       "code": # some error code, 
       "message": # some error explaining message 
      } 
} 

Answer 1

あなたのAPIレスポンスを設計するための多くの方法があります。あなたのアーキテクチャ、技術、およびその他の側面に条件付きです。このトピックは取るに関する詳細情報については

{ 
    "status": "error", 
    "code": 404, 
    "data": null, /* or optional error payload */ 
    "message": "Error xyz has occurred" 
} 

：

{ 
    "status": "success", 
    "data": { 
      /* Application-specific data would go here. */ 
    }, 
    "message": null /* Or optional success message */ 
} 

失敗した要求：あなたの例に基づいて

、私はこのように

成功した要求を応答しますこのリンクを見てください

Standard JSON API response format?

Best Practices for Designing a Pragmatic RESTful API

REST API Error Codes 101