来自 ASP.Net Web API 2 的统一、一致的错误响应

Question

我正在开发一个 Web API 2 应用程序，我目前正在尝试以统一的方式格式化错误响应（这样消费者也将知道他们可以检查哪些数据对象/结构以获取有关错误的更多信息） .这是我到目前为止所得到的：

{   
    "Errors":
    [
        {
            "ErrorType":5003,
            "Message":"Error summary here",
            "DeveloperAction":"Some more detail for API consumers (in some cases)",
            "HelpUrl":"link to the docs etc."
        }
    ]
}

这适用于应用程序本身（即控制器内部）抛出的异常。但是，如果用户请求错误的 URI（并获得 404）或使用错误的动词（并获得 405）等，Web Api 2 会输出默认错误消息，例如

{
     Message: "No HTTP resource was found that matches the request URI 'http://localhost/abc'."
}

有什么方法可以捕获这些类型的错误（404、405 等）并将它们格式化为上面第一个示例中的错误响应？

到目前为止我已经尝试过：

• 自定义 ExceptionAttribute 继承 ExceptionFilterAttribute
• 自定义 ControllerActionInvoker 继承 ApiControllerActionInvoker
• IExceptionHandler（来自 Web API 2.1 的新全局错误处理功能）

但是，这些方法都无法捕获这些类型的错误（404、405 等）。关于如何/是否可以实现的任何想法？

...或者，我是不是走错了路？我是否应该只针对应用程序/用户级别的错误以我的特定样式格式化错误响应，并依赖默认的错误响应来处理 404 之类的问题？

Answer 1

您可以重写 DelegatingHandler 抽象类并拦截对客户端的响应。这将使您能够返回您想要的东西。

这里有一些关于它的信息。 http://msdn.microsoft.com/en-us/library/system.net.http.delegatinghandler(v=vs.118).aspx

这是 Web Api 管道的海报，展示了可以覆盖的内容。 http://www.asp.net/posters/web-api/asp.net-web-api-poster.pdf

像这样创建一个 Handler 类来覆盖响应

public class MessageHandler1 : DelegatingHandler
{
    protected override Task<HttpResponseMessage> SendAsync(
HttpRequestMessage request, CancellationToken cancellationToken)
    {
        Debug.WriteLine("Process request");
        // Call the inner handler.
        var response = base.SendAsync(request, cancellationToken);

        Debug.WriteLine("Process response");
        if (response.Result.StatusCode == HttpStatusCode.NotFound)
        {
            //Create new HttpResponseMessage message
        }
        ;
        return response;
    }
}

在您的 WebApiConfig.cs 类中添加处理程序。

config.MessageHandlers.Add(new MessageHandler1());

更新 正如 Kiran 在 cmets 中提到的，您可以使用 OwinMiddleware 拦截返回给客户端的响应。这适用于在任何主机上运行的 MVC 和 Web Api。

这是一个如何获取响应并在响应发送到客户端时对其进行更改的示例。

public class Startup
{
    public void Configuration(IAppBuilder app)
    {
        app.Use(typeof(MyMiddleware)); 
    }
}

public class MyMiddleware : OwinMiddleware
{
    public MyMiddleware(OwinMiddleware next) : base(next) { }

    public override async Task Invoke(IOwinContext context)
    {
        await Next.Invoke(context);
        if(context.Response.StatusCode== 404)
        {
            context.Response.StatusCode = 403;
            context.Response.ReasonPhrase = "Blah";
        }
    }
}

Answer 2

我的做法和@Dan H 提到的一样

 public class ApiGatewayHandler : DelegatingHandler
{
    protected async override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
        try
        {
            var response = await base.SendAsync(request, cancellationToken);
            if (response.StatusCode == HttpStatusCode.NotFound)
            {
                var objectContent = response.Content as ObjectContent;
                return await Task.FromResult(new ApiResult(HttpStatusCode.NotFound, VmsStatusCodes.RouteNotFound, "", objectContent == null ? null : objectContent.Value).Response());
            }
            return response;
        }
        catch (System.Exception ex)
        {
            return await Task.FromResult(new ApiResult(HttpStatusCode.BadRequest, VmsStatusCodes.UnHandledError, ex.Message, "").Response());
        }

    }
}

添加了如下所示的路由，现在它命中了无效 url 的 try catch

  config.Routes.MapHttpRoute(name: "DefaultApi",routeTemplate: "api/{controller}/{id}",defaults: new { id = RouteParameter.Optional });
        config.Routes.MapHttpRoute(name: "NotFound", routeTemplate: "api/{*paths}", defaults: new { controller = "ApiError", action = "NotFound" });