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

通常，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) {
  ....
}

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

有点晚了，但这是我对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的关键在于它是完全动态和灵活的。你可以随心所欲地使用它，因为它只是一组序列化的JavaScript对象和数组，植根于一个节点。

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

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

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

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

RFC 7807：HTTP API的问题细节是目前最接近官方标准的内容。

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

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

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

以下是instagram使用的json格式

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