我们应该在异常时发送什么响应代码 - WebAPI？

Question

我正在写Web-API 方法。一种这样的方法类似于

public IHttpActionResult Post([FromBody]MyDTO)
{
   //validations 

   try
   {
      InsertInToDB(MyDTO.SomeField);
   }
   catch(Exception ex)
   {
      // Say some exception has occurred while inserting in to DB. For eg. SomeField is not a acceptable value.
      // What is the response that I should send to the API user ?
      // Notfound, BadRequest does not seem to be fit in this case.
   }

}

注意：InsertIntoDB 返回 void

现在，如果该方法中出现一些异常，我应该发送给用户的HttpStatusCode 应该是什么？

NotFound 或 Badrequest 响应似乎不适合这种情况。有什么想法吗？

Answer 1

您发回的异常取决于几件事。

首先，用户是否向您发送了不良信息？还是你的服务器搞砸了？

4XX 状态码用于用户搞砸的时候。

4XX：

如果问题是用户发送了格式错误的请求，则返回400 Bad Request。

如果问题是您使用 POST 来确定资源是否存在（例如通过搜索），那么如果他们尝试访问的资源未找到，则 404 Not Found 将是合适的。

如果问题是插入此值会导致现有值出现问题（假设它们具有完全相同的名称，但它们不应该；或其他一些验证式错误：409 Conflict 是合适的。

5XX

5XX 状态码用于您的代码出错时。用户做对了一切，但你还是搞砸了。

例如，if your database is down, a 500 or 503 is appropriate。

顺便说一句，抓住毯子Exception 很糟糕。在这种情况下，如果您有不同的验证，您应该创建可以在出现验证错误时抛出的异常类；以区别于用户编写的所有内容但代码出错。

在这种情况下，我会：

ValidationFailedException -> Web 层返回 400 ConflictException -> Web 层返回 409 ItemDoesNotExistException -> Web 层返回 404

请注意，您的数据层不应依赖于 Web 层或任何与 Internet 相关的内容。这意味着您应该有内部异常类；抛出这些，并使用它们在您的 Web 层中生成适当的 HttpException。