是否存在从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!"
}
}
当前回答
建议的基本框架看起来不错，但定义的错误对象太有限。人们通常不能用一个值来表达问题，而是需要一系列问题和原因。
我做了一点研究，发现返回错误（异常）最常见的格式是以下形式的结构：
{
"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-RPC 2.0定义了一种标准的请求和响应格式，在使用REST API之后，它是一股新鲜空气。
假设您的问题是关于REST Web服务设计，更准确地说是关于成功/错误。
我认为有三种不同类型的设计。
仅使用HTTP状态代码来指示是否存在错误，并尝试将自己限制在标准状态（通常这就足够了）。优点：它是一个独立于api的标准。缺点：关于真实发生的事情的信息较少。使用HTTP Status+json主体（即使是错误）。为错误定义一个统一的结构（例如：代码、消息、原因、类型等），并将其用于错误，如果成功，则返回预期的json响应。优点：仍然是标准的，因为您使用现有的HTTP状态代码，并返回一个描述错误的json（您提供了有关发生的更多信息）。缺点：输出json会因错误或成功而有所不同。忘记http状态（例如：always status 200），始终使用json，并在响应的根位置添加一个布尔responseValid和一个错误对象（代码、消息等），如果是错误，将填充该对象，否则将填充其他字段（成功）。优点：客户端只处理作为json字符串的响应主体，而忽略状态（？）。缺点：标准越低。
这取决于您的选择：）
根据API的不同，我会选择2或3（对于json rest API，我更喜欢2）。我在设计RESTApi时经历的另一件事是每个资源（url）的文档的重要性：参数、主体、响应、头等+示例。
我还建议您使用jersey（jax-rs实现）+genson（java/json数据绑定库）。您只需在类路径中删除genson+jersey，就会自动支持json。
编辑：
解决方案2是最难实现的，但它的优点是，您可以很好地处理异常，而不仅仅是业务错误，最初的努力更重要，但从长远来看，您会赢得胜利。解决方案3在服务器端和客户端都很容易实现，但它并不是很好，因为您必须将要返回的对象封装在包含responseValid+错误的响应对象中。
除了常识之外，没有违法或非法的标准。如果我们像两个人说话一样抽象这一点，那么标准就是他们在最短时间内用最少的语言准确理解对方的最佳方式。在我们的例子中，“最小单词”是优化带宽以提高传输效率，而“准确理解”是提高解析器效率的结构；这最终导致数据越少，结构越常见；以便它可以穿过针孔并且可以通过公共范围（至少最初）解析。
几乎在所建议的每一种情况下，我都会看到“成功”和“错误”场景的单独响应，这对我来说有点模糊。如果这两种情况下的响应不同，那么为什么我们真的需要在那里设置“成功”标志呢？不存在“错误”是否意味着“成功”？“成功”为TRUE且设置了“错误”时，是否可能有响应？或者，如果没有设置“错误”，则“成功”为FALSE？仅仅一个旗帜是不够的？我更希望只有“错误”标志，因为我相信“错误”比“成功”少。
此外，我们真的应该将“错误”设置为标志吗？如果我想回复多个验证错误怎么办？因此，我发现有一个“Error”节点更有效，每个错误都是该节点的子节点；其中空的（计数为零）“错误”节点表示“成功”。
Google JSON指南
成功响应返回数据
{
"data": {
"id": 1001,
"name": "Wing"
}
}
错误响应返回错误
{
"error": {
"code": 404,
"message": "ID not found"
}
}
如果您的客户端是JS，则可以使用if（响应中的“error”）｛｝来检查是否存在错误。
JSON的关键在于它是完全动态和灵活的。你可以随心所欲地使用它，因为它只是一组序列化的JavaScript对象和数组，植根于一个节点。
rootnode的类型取决于您，它包含的内容取决于您、是否随响应一起发送元数据取决于您以及是否将mime类型设置为application/json或将其保留为text/plain取决于您（只要您知道如何处理边缘情况）。
构建您喜欢的轻量级模式。就我个人而言，我发现分析跟踪、mp3/ogg服务、图片库服务、在线游戏的短信和网络包、博客帖子和博客评论在发送内容、接收内容以及如何消费方面都有着非常不同的要求。
所以，在完成所有这些工作时，我最不想做的就是让每一个都符合相同的样板标准，该标准基于XML2.0或类似的标准。
也就是说，使用对你有意义且经过深思熟虑的模式有很多值得说的地方。只需阅读一些API响应，注意你喜欢的，批评你不喜欢的，写下这些批评，并理解它们为什么会让你感到不舒服，然后思考如何将你学到的东西应用到你需要的东西上。
