未找到 API 记录

Question

我构建了这个 API，如果找到该 Id，它将返回数据。但是，如果找不到该 ID，我将返回 409。当我在邮递员中对其进行测试时，我看到状态为 409 是否正确？这就是我所需要的，还是应该在正文中返回一些文本？

    [HttpGet]
    public IHttpActionResult Read(string type, string id)
     {
        if (id== null)
        {
           var msg = new HttpResponseMessage(HttpStatusCode.NotFound) { ReasonPhrase = "Unable to Find Id" };
msg.Content= new StringContent($"No entity with {id} was found");
           return ResponseMessage(msg);
        }
     }

Answer 1

您确实会看到“未找到”文本：

您在正文中看不到任何内容，因为您的 API 不发送正文，只是发送 HTTP 标头

您的评论，并在 GPW 的建议中链接，返回一些自定义的东西 - 让错误成为错误，并将这种可预见的情况作为“OK 但没有”响应，也许：

[HttpGet]
public ActionResult Read(string type, string id)
 {
    if (id == null)
       return Json(new { status= "fail", message= "id parameter is required" });
    else if (type == null)
       return Json(new { status= "fail", message= "type parameter is required" });


    var ent = dbcontext.Entity.FirstOrDefault(e => e.Type == type && e.Id == id);

    if(ent == null)
      return Json(new { status="fail", message= "No entity with that type/id was found" });
    else
      return Json(new { status="ok", entityName= ent.Name });

 }

在我们的一个应用程序中，我们确实使用 HTTP 错误来改变客户端的行为 - 在客户端 react 应用程序中有一个承诺链，我们使用返回错误来停止链的处理，解析错误，然后继续回到解析知道 JSON 是一个稍微不同的形状。我不相信这是一个很好的方法，因为它使客户端比它本来可以做的更复杂，但是如果你想这样做，那么确定，看看返回有意义的 http 错误的方法。就个人而言（和 GPW 暗示它）甚至调试，很多时候我错过了邮递员的返回码，得到一个空白的响应，被误导，除了实际发生的事情之外还有其他错误/得到 404 并认为后端不能'实际上我弄错了 URL 并且由于不同的原因得到 404 等时找不到实体