从 Asp.Net MVC 6 API 返回 JSON 错误

Question

我正在尝试使用 MVC 6 构建 Web API。但是当我的一个控制器方法抛出错误时，响应的内容是一个格式非常精美的 HTML 页面，如果这是一个 MVC 应用程序，它将提供非常丰富的信息。但由于这是一个 API，我宁愿返回一些 JSON。

注意：我现在的设置是超级基本的，只是设置：

    app.UseStaticFiles();
    app.UseIdentity();

    // Add MVC to the request pipeline.
    app.UseMvc();

我想进行通用设置。是否有“正确/最佳”的方式在 MVC 6 中为 API 进行设置？

谢谢...

Answer 1

实现您的方案的一种方法是编写ExceptionFilter 并在其中捕获必要的详细信息并将Result 设置为JsonResult。

// Here I am creating an attribute so that you can use it on specific controllers/actions if you want to.
public class CustomExceptionFilterAttribute : ExceptionFilterAttribute
{
    public override void OnException(ExceptionContext context)
    {
        var exception = context.Exception;
        context.Result = new JsonResult(/*Your POCO type having necessary details*/)
        {
            StatusCode = (int)HttpStatusCode.InternalServerError
        };
    }
}

您可以添加此异常过滤器以适用于所有控制器。 示例：

app.UseServices(services =>
{
    services.AddMvc();
    services.Configure<MvcOptions>(options =>
    {
        options.Filters.Add(new CustomExceptionFilterAttribute());
    });
.....
}

请注意，此解决方案并未涵盖所有场景...例如，当格式化程序写入响应时引发异常时。