有点晚了，但这是我对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 }}, // [] ...
      });

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+错误的响应对象中。

Google JSON指南

成功响应返回数据

{
  "data": {
    "id": 1001,
    "name": "Wing"
  }
}

错误响应返回错误

{
  "error": {
    "code": 404,
    "message": "ID not found"
  }
}

如果您的客户端是JS，则可以使用if（响应中的“error”）｛｝来检查是否存在错误。

我曾经遵循这个标准，在客户端层非常好、简单、干净。

通常，HTTP状态为200，所以这是我在顶部使用的标准检查。我通常使用以下JSON

我还使用API的模板

dynamic response;

try {
   // query and what not.
   response.payload = new {
      data = new {
          pagination = new Pagination(),
          customer = new Customer(),
          notifications = 5
      }
   }

   // again something here if we get here success has to be true
   // I follow an exit first strategy, instead of building a pyramid 
   // of doom.
   response.success = true;
}
catch(Exception exception){
   response.success = false;
   response.message = exception.GetStackTrace();
   _logger.Fatal(exception, this.GetFacadeName())
}

return response;

{ 
  "success": boolean,
  "message": "some message",
  "payload": { 
     "data" : []
     "message": ""
     ... // put whatever you want to here.
  } 
}

在客户端层上，我将使用以下内容：

if(response.code != 200) { 
  // woops something went wrong.
  return;
}

if(!response.success){
  console.debug ( response.message ); 
  return;
}

// if we are here then success has to be true.
if(response.payload) {
  ....
}

请注意我是如何提前打破厄运金字塔的。

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

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

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

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

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