是否存在从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!"
}
}
当前回答
为了值得，我采取了不同的做法。成功的调用只有JSON对象。我不需要更高级别的JSON对象，它包含一个指示true的成功字段和一个包含JSON对象的有效负载字段。我只需要返回一个适当的JSON对象，该对象带有一个200或任何在200范围内适合于标头中HTTP状态的值。
但是，如果有错误（400系列中的某些错误），我会返回一个格式良好的JSON错误对象。例如，如果客户端向用户发送电子邮件地址和电话号码，其中一个错误（即我无法将其插入基础数据库），我将返回如下内容：
{
"description" : "Validation Failed"
"errors" : [ {
"field" : "phoneNumber",
"message" : "Invalid phone number."
} ],
}
这里重要的一点是，“field”属性必须与无法验证的JSON字段完全匹配。这可以让客户确切地知道他们的请求出了什么问题。此外，“message”位于请求的区域设置中。如果“emailAddress”和“phoneNumber”都无效，那么“errors”数组将包含两者的条目。409（冲突）JSON响应体可能如下所示：
{
"description" : "Already Exists"
"errors" : [ {
"field" : "phoneNumber",
"message" : "Phone number already exists for another user."
} ],
}
有了HTTP状态代码和JSON，客户机就拥有了以确定性方式响应错误所需的一切，并且不会创建新的错误标准来尝试完全替换HTTP状态代码。注意，这些错误只发生在400个错误的范围内。对于200范围内的任何东西，我可以返回任何合适的东西。对我来说，它通常是一个类似于HAL的JSON对象，但这在这里并不重要。
我想添加的一件事是在“errors”数组条目或JSON对象本身的根中添加一个数字错误代码。但到目前为止，我们还不需要它。
其他回答
除了常识之外，没有违法或非法的标准。如果我们像两个人说话一样抽象这一点，那么标准就是他们在最短时间内用最少的语言准确理解对方的最佳方式。在我们的例子中，“最小单词”是优化带宽以提高传输效率，而“准确理解”是提高解析器效率的结构；这最终导致数据越少，结构越常见；以便它可以穿过针孔并且可以通过公共范围（至少最初）解析。
几乎在所建议的每一种情况下，我都会看到“成功”和“错误”场景的单独响应，这对我来说有点模糊。如果这两种情况下的响应不同，那么为什么我们真的需要在那里设置“成功”标志呢？不存在“错误”是否意味着“成功”？“成功”为TRUE且设置了“错误”时，是否可能有响应？或者，如果没有设置“错误”，则“成功”为FALSE？仅仅一个旗帜是不够的？我更希望只有“错误”标志，因为我相信“错误”比“成功”少。
此外，我们真的应该将“错误”设置为标志吗？如果我想回复多个验证错误怎么办？因此，我发现有一个“Error”节点更有效，每个错误都是该节点的子节点；其中空的（计数为零）“错误”节点表示“成功”。
我将此结构用于REST API：
{
"success": false,
"response": {
"data": [],
"pagination": {}
},
"errors": [
{
"code": 500,
"message": "server 500 Error"
}
]
}
Google JSON指南
成功响应返回数据
{
"data": {
"id": 1001,
"name": "Wing"
}
}
错误响应返回错误
{
"error": {
"code": 404,
"message": "ID not found"
}
}
如果您的客户端是JS，则可以使用if（响应中的“error”）｛｝来检查是否存在错误。
是的，出现了一些标准（尽管在标准定义上有些自由）：
JSON API-JSON API还包括创建和更新资源，而不仅仅是响应。JSend-简单，可能是您已经在做的事情。OData JSON协议-非常复杂。哈尔-像OData，但目标是像HATEOAS。
还有JSON API描述格式：
大摇大摆JSON模式（swagger使用，但可以单独使用）JSON格式的WADL冲压，冲压HAL，因为理论上HATEOAS是自我描述的。
他们对大型软件巨头（谷歌、脸书、推特、亚马逊等）的rest api响应格式没有达成一致，尽管上面的答案中提供了许多链接，一些人已经尝试将响应格式标准化。
由于API的需求可能不同，很难让每个人都加入并同意某种格式。如果您有数百万用户使用您的API，为什么要更改响应格式？
以下是我对谷歌、推特、亚马逊和互联网上一些帖子的回应格式的看法：
https://github.com/adnan-kamili/rest-api-response-format
交换文件：
https://github.com/adnan-kamili/swagger-sample-template
