为了值得，我采取了不同的做法。成功的调用只有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对象本身的根中添加一个数字错误代码。但到目前为止，我们还不需要它。

我想事实上的标准还没有真正出现（可能永远不会）。但无论如何，我的看法是：

成功的请求：

{
  "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"
}

优势：成功和错误案例中的顶级元素相同

缺点：没有错误代码，但如果您愿意，您可以将状态更改为（成功或失败）代码，或者-您可以添加另一个名为“代码”的顶级项。

除了常识之外，没有违法或非法的标准。如果我们像两个人说话一样抽象这一点，那么标准就是他们在最短时间内用最少的语言准确理解对方的最佳方式。在我们的例子中，“最小单词”是优化带宽以提高传输效率，而“准确理解”是提高解析器效率的结构；这最终导致数据越少，结构越常见；以便它可以穿过针孔并且可以通过公共范围（至少最初）解析。

几乎在所建议的每一种情况下，我都会看到“成功”和“错误”场景的单独响应，这对我来说有点模糊。如果这两种情况下的响应不同，那么为什么我们真的需要在那里设置“成功”标志呢？不存在“错误”是否意味着“成功”？“成功”为TRUE且设置了“错误”时，是否可能有响应？或者，如果没有设置“错误”，则“成功”为FALSE？仅仅一个旗帜是不够的？我更希望只有“错误”标志，因为我相信“错误”比“成功”少。

此外，我们真的应该将“错误”设置为标志吗？如果我想回复多个验证错误怎么办？因此，我发现有一个“Error”节点更有效，每个错误都是该节点的子节点；其中空的（计数为零）“错误”节点表示“成功”。

有点晚了，但这是我对HTTP错误响应的看法，我发送代码（通过状态）、通用消息和详细信息（如果我想提供特定端点的详细信息，有些是不言自明的，因此不需要详细信息，但它可以是自定义消息，甚至可以是完整的堆栈跟踪，具体取决于用例）。为了成功，数据属性中的格式、代码、消息和任何数据都是类似的。

ExpressJS响应示例：

// Error

    res
      .status(422)
      .json({
        error: {
          message: 'missing parameters',
          details: `missing ${missingParam}`,
        }
      });
        
    // or
        
    res
      .status(422)
      .json({
        error: {
          message: 'missing parameters',
          details: 'expected: {prop1, prop2, prop3',
        }
      });

 // Success

    res
      .status(200)
      .json({
         message: 'password updated',
         data: {member: { username }}, // [] ...
      });

以下是instagram使用的json格式

{
    "meta": {
         "error_type": "OAuthException",
         "code": 400,
         "error_message": "..."
    }
    "data": {
         ...
    },
    "pagination": {
         "next_url": "...",
         "next_max_id": "13872296"
    }
}

JSON的关键在于它是完全动态和灵活的。你可以随心所欲地使用它，因为它只是一组序列化的JavaScript对象和数组，植根于一个节点。

rootnode的类型取决于您，它包含的内容取决于您、是否随响应一起发送元数据取决于您以及是否将mime类型设置为application/json或将其保留为text/plain取决于您（只要您知道如何处理边缘情况）。

构建您喜欢的轻量级模式。就我个人而言，我发现分析跟踪、mp3/ogg服务、图片库服务、在线游戏的短信和网络包、博客帖子和博客评论在发送内容、接收内容以及如何消费方面都有着非常不同的要求。

所以，在完成所有这些工作时，我最不想做的就是让每一个都符合相同的样板标准，该标准基于XML2.0或类似的标准。

也就是说，使用对你有意义且经过深思熟虑的模式有很多值得说的地方。只需阅读一些API响应，注意你喜欢的，批评你不喜欢的，写下这些批评，并理解它们为什么会让你感到不舒服，然后思考如何将你学到的东西应用到你需要的东西上。