是否存在从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!"
}
}
当前回答
他们对大型软件巨头（谷歌、脸书、推特、亚马逊等）的rest api响应格式没有达成一致，尽管上面的答案中提供了许多链接，一些人已经尝试将响应格式标准化。
由于API的需求可能不同，很难让每个人都加入并同意某种格式。如果您有数百万用户使用您的API，为什么要更改响应格式？
以下是我对谷歌、推特、亚马逊和互联网上一些帖子的回应格式的看法：
https://github.com/adnan-kamili/rest-api-response-format
交换文件：
https://github.com/adnan-kamili/swagger-sample-template
其他回答
以下是instagram使用的json格式
{
"meta": {
"error_type": "OAuthException",
"code": 400,
"error_message": "..."
}
"data": {
...
},
"pagination": {
"next_url": "...",
"next_max_id": "13872296"
}
}
Google JSON指南
成功响应返回数据
{
"data": {
"id": 1001,
"name": "Wing"
}
}
错误响应返回错误
{
"error": {
"code": 404,
"message": "ID not found"
}
}
如果您的客户端是JS，则可以使用if（响应中的“error”）｛｝来检查是否存在错误。
我想事实上的标准还没有真正出现（可能永远不会）。但无论如何，我的看法是：
成功的请求：
{
"status": "success",
"data": {
/* Application-specific data would go here. */
},
"message": null /* Or optional success message */
}
失败的请求：
{
"status": "error",
"data": null, /* or optional error payload */
"message": "Error xyz has occurred"
}
优势：成功和错误案例中的顶级元素相同
缺点：没有错误代码，但如果您愿意，您可以将状态更改为（成功或失败）代码，或者-您可以添加另一个名为“代码”的顶级项。
建议的基本框架看起来不错，但定义的错误对象太有限。人们通常不能用一个值来表达问题，而是需要一系列问题和原因。
我做了一点研究，发现返回错误（异常）最常见的格式是以下形式的结构：
{
"success": false,
"error": {
"code": "400",
"message": "main error message here",
"target": "approx what the error came from",
"details": [
{
"code": "23-098a",
"message": "Disk drive has frozen up again. It needs to be replaced",
"target": "not sure what the target is"
}
],
"innererror": {
"trace": [ ... ],
"context": [ ... ]
}
}
}
这是OASIS数据标准OASIS OData提出的格式，似乎是最标准的选项，但目前任何标准的采用率似乎都不高。此格式与JSON-RPC规范一致。
您可以在以下位置找到实现此功能的完整开源库：Mendocino JSON Utilities。该库支持JSON对象以及异常。
详细信息在我关于JSON REST API中的错误处理的博客文章中讨论
我不会傲慢地宣称这是一个标准，所以我会使用“我更喜欢”的形式。
我更喜欢简洁的响应（当请求/articles列表时，我需要一个JSON文章数组）。
在我的设计中，我使用HTTP进行状态报告，200只返回有效负载。
400返回请求出错的消息：
{"message" : "Missing parameter: 'param'"}
如果模型/控制器/URI不存在，则返回404
如果我这边的处理出现错误，我会返回501并返回消息：
{"message" : "Could not connect to data store."}
从我所看到的情况来看，相当多的REST框架都是这样的。
理论基础：
JSON应该是一种有效载荷格式，而不是会话协议。冗长的会话式有效负载的整个概念来自XML/SOAP世界，以及导致这些臃肿设计的各种错误选择。在我们意识到所有这些都是一个令人头疼的问题之后，REST/JSON的全部目的就是KISS，并遵守HTTP。我不认为JSend中有任何远程标准，尤其是其中更冗长的部分。XHR将对HTTP响应做出反应，如果您对AJAX使用jQuery（像大多数人一样），您可以使用try/catch和done（）/fail（）回调来捕获错误。我看不出用JSON封装状态报告有多有用。
