是否存在从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!"
}
}
当前回答
我想事实上的标准还没有真正出现（可能永远不会）。但无论如何，我的看法是：
成功的请求：
{
"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"
}
优势：成功和错误案例中的顶级元素相同
缺点：没有错误代码，但如果您愿意，您可以将状态更改为（成功或失败）代码，或者-您可以添加另一个名为“代码”的顶级项。
其他回答
我想事实上的标准还没有真正出现（可能永远不会）。但无论如何，我的看法是：
成功的请求：
{
"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中的错误处理的博客文章中讨论
JSON的关键在于它是完全动态和灵活的。你可以随心所欲地使用它，因为它只是一组序列化的JavaScript对象和数组，植根于一个节点。
rootnode的类型取决于您，它包含的内容取决于您、是否随响应一起发送元数据取决于您以及是否将mime类型设置为application/json或将其保留为text/plain取决于您（只要您知道如何处理边缘情况）。
构建您喜欢的轻量级模式。就我个人而言，我发现分析跟踪、mp3/ogg服务、图片库服务、在线游戏的短信和网络包、博客帖子和博客评论在发送内容、接收内容以及如何消费方面都有着非常不同的要求。
所以，在完成所有这些工作时，我最不想做的就是让每一个都符合相同的样板标准，该标准基于XML2.0或类似的标准。
也就是说，使用对你有意义且经过深思熟虑的模式有很多值得说的地方。只需阅读一些API响应，注意你喜欢的，批评你不喜欢的，写下这些批评，并理解它们为什么会让你感到不舒服，然后思考如何将你学到的东西应用到你需要的东西上。
是的，出现了一些标准（尽管在标准定义上有些自由）：
JSON API-JSON API还包括创建和更新资源，而不仅仅是响应。JSend-简单，可能是您已经在做的事情。OData JSON协议-非常复杂。哈尔-像OData，但目标是像HATEOAS。
还有JSON API描述格式：
大摇大摆JSON模式（swagger使用，但可以单独使用）JSON格式的WADL冲压，冲压HAL，因为理论上HATEOAS是自我描述的。
以下是instagram使用的json格式
{
"meta": {
"error_type": "OAuthException",
"code": 400,
"error_message": "..."
}
"data": {
...
},
"pagination": {
"next_url": "...",
"next_max_id": "13872296"
}
}
