REST API是否应该在响应体中返回异常？

Question

这方面的最佳实践是什么。NET与Web API？特别是WebRESTAPI。当异常发生时，RESTAPI是否应该在响应体中返回异常？

当然，我会返回500或类似的HTTP状态。但是当我用这个错误代码响应时，最佳实践是什么？或者更好的是，规范或RESTAPI对此有何规定？

• 返回异常（我所做的）

Answer 1

无论如何是的，您应该在响应的主体中包含异常的表示。异常将是错误的最佳解释，它将是帮助用户纠正错误的最有帮助的。我建议所有错误的响应代码为400，但是400范围内的任何数字都是可以接受的。

我做了一些研究，发现最常见的/标准使用这种形式的JSON结构：

{
   "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": [ ... ]
      }
   }
}

其中很多都是可选的，但如果您需要它们，它们是可以选择的。关于这个结构，重要的一点是错误是在成员“error”下的对象中描述的。

这是OASIS数据标准OASIS OData提出的格式，似乎是最标准的选择，但是在这一点上似乎没有任何标准的高采用率。

细节在我关于JSON REST API错误处理的博客文章中讨论过

Answer 2

我有这个建议。

>

该错误需要由应用程序（API）中的某些过滤器处理。这个过滤器将获得意外的错误，在超文本传输协议状态代码等于500的JSON中转换错误。

返回的错误需要具有相同的JSON格式，如下所示：

{
    code: 12321312,
    message: "A fatal error occurred",
    details: "An unexpected information was passed as parameter to the API."
}

错误格式需要提供信息。当您在过滤器中获得错误时，您可以使用生成的代码（错误代码，如UUID）将错误保存在数据库中，并在JSON中返回code。为了有一个好的API，使用错误代码将是一个很好的特性，并将帮助您识别问题。

Answer 3

返回异常（我所做的）-

返回空的反应体？-

返回一个空的默认JSON对象？-

别的东西？-