ASP.NET Web API 2如何返回带404状态码的JSON结果

你需要返回404状态码且Content-Type为application/json的错误响应，模仿GitHub API的格式。之前的两种实现存在以下问题：

• 第一种手动序列化对象导致Content-Type不是JSON，因为传入的是字符串，Web API默认将其识别为text/plain
• 第二种用Json()方法只能返回200状态码，无法指定错误状态码

正确实现方式 #

直接使用Content()方法，传入HttpStatusCode.NotFound和错误对象，Web API会自动完成JSON序列化并设置正确的Content-Type：

[RoutePrefix("error")]
public class ErrorController : MyBaseApiController
{
    [HttpGet]
    [Route("notfound")]
    public IHttpActionResult NotFoundMessage()
    {
        var errorResponse = new 
        { 
            Message = "Not found", 
            DocumentationUrl = "My documentation path" 
        };
        return Content(HttpStatusCode.NotFound, errorResponse);
    }
}

原理说明 #

• 向Content()方法传入对象而非序列化后的字符串时，Web API会根据请求配置自动选用JSON格式化器，因此会正确设置Content-Type: application/json
• 指定HttpStatusCode.NotFound可确保响应状态码为404，完全符合需求

全局统一处理扩展（可选） #

如果需要在整个API中统一处理404错误，还可以自定义IHttpActionResult或异常过滤器，但单个接口场景下，上述方法最为直接高效。

内容的提问来源于stack exchange，提问作者Hooman Bahreini