是否存在从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!"
}
}
当前回答
除了常识之外，没有违法或非法的标准。如果我们像两个人说话一样抽象这一点，那么标准就是他们在最短时间内用最少的语言准确理解对方的最佳方式。在我们的例子中，“最小单词”是优化带宽以提高传输效率，而“准确理解”是提高解析器效率的结构；这最终导致数据越少，结构越常见；以便它可以穿过针孔并且可以通过公共范围（至少最初）解析。
几乎在所建议的每一种情况下，我都会看到“成功”和“错误”场景的单独响应，这对我来说有点模糊。如果这两种情况下的响应不同，那么为什么我们真的需要在那里设置“成功”标志呢？不存在“错误”是否意味着“成功”？“成功”为TRUE且设置了“错误”时，是否可能有响应？或者，如果没有设置“错误”，则“成功”为FALSE？仅仅一个旗帜是不够的？我更希望只有“错误”标志，因为我相信“错误”比“成功”少。
此外，我们真的应该将“错误”设置为标志吗？如果我想回复多个验证错误怎么办？因此，我发现有一个“Error”节点更有效，每个错误都是该节点的子节点；其中空的（计数为零）“错误”节点表示“成功”。
其他回答
是的，出现了一些标准（尽管在标准定义上有些自由）：
JSON API-JSON API还包括创建和更新资源，而不仅仅是响应。JSend-简单，可能是您已经在做的事情。OData JSON协议-非常复杂。哈尔-像OData，但目标是像HATEOAS。
还有JSON API描述格式：
大摇大摆JSON模式（swagger使用，但可以单独使用）JSON格式的WADL冲压，冲压HAL，因为理论上HATEOAS是自我描述的。
JSON-RPC 2.0定义了一种标准的请求和响应格式，在使用REST API之后，它是一股新鲜空气。
我想事实上的标准还没有真正出现（可能永远不会）。但无论如何，我的看法是：
成功的请求：
{
"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中的错误处理的博客文章中讨论
除了常识之外，没有违法或非法的标准。如果我们像两个人说话一样抽象这一点，那么标准就是他们在最短时间内用最少的语言准确理解对方的最佳方式。在我们的例子中，“最小单词”是优化带宽以提高传输效率，而“准确理解”是提高解析器效率的结构；这最终导致数据越少，结构越常见；以便它可以穿过针孔并且可以通过公共范围（至少最初）解析。
几乎在所建议的每一种情况下，我都会看到“成功”和“错误”场景的单独响应，这对我来说有点模糊。如果这两种情况下的响应不同，那么为什么我们真的需要在那里设置“成功”标志呢？不存在“错误”是否意味着“成功”？“成功”为TRUE且设置了“错误”时，是否可能有响应？或者，如果没有设置“错误”，则“成功”为FALSE？仅仅一个旗帜是不够的？我更希望只有“错误”标志，因为我相信“错误”比“成功”少。
此外，我们真的应该将“错误”设置为标志吗？如果我想回复多个验证错误怎么办？因此，我发现有一个“Error”节点更有效，每个错误都是该节点的子节点；其中空的（计数为零）“错误”节点表示“成功”。
