8

有没有办法改变 Web Api 对错误消息的默认行为,例如:

GET /trips/abc

回应(转述):

HTTP 500 Bad Request

{
    "Message": "The request is invalid.",
    "MessageDetail": "The parameters dictionary contains a null entry for parameter 'tripId' of non-nullable type 'System.Guid' for method 'System.Net.Http.HttpResponseMessage GetTrip(System.Guid)' in 'Controllers.TripController'. An optional parameter must be a reference type, a nullable type, or be declared as an optional parameter."
}

我想避免给出关于我的代码的这个相当详细的信息,而是用类似的东西替换它:

HTTP 500 Bad Request
{
    error: true,
    error_message: "invalid parameter"
}

我可以在 UserController 中做到这一点,但代码执行甚至没有那么远。

编辑:

我找到了一种从输出中删除详细错误消息的方法,使用 Global.asax.cs 中的这行代码:

GlobalConfiguration.Configuration.IncludeErrorDetailPolicy =
IncludeErrorDetailPolicy.LocalOnly;

这会产生如下消息:

{
    "Message": "The request is invalid."
}

哪个更好,但不完全是我想要的 - 我们指定了许多数字错误代码,这些代码映射到客户端的详细错误消息。我只想输出适当的错误代码(我可以在输出之前选择,最好通过查看发生的异常类型),例如:

{ error: true, error_code: 51 }
4

2 回答 2

8

即使您想隐藏有关实际异常的详细信息,您也可能希望将数据的形状保持为 HttpError 类型。为此,您可以添加自定义 DelegatingHandler 来修改服务抛出的 HttpError。

下面是 DelegatingHandler 的样例:

public class CustomModifyingErrorMessageDelegatingHandler : DelegatingHandler
{
    protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
        return base.SendAsync(request, cancellationToken).ContinueWith<HttpResponseMessage>((responseToCompleteTask) =>
        {
            HttpResponseMessage response = responseToCompleteTask.Result;

            HttpError error = null;
            if (response.TryGetContentValue<HttpError>(out error))
            {
                error.Message = "Your Customized Error Message";
                // etc...
            }

            return response;
        });
    }
}
于 2012-10-22T18:37:24.263 回答
2

Maggie 的回答也对我有用。感谢您的发布!

只是想对她的代码做一些补充说明:

HttpResponseMessage response = responseToCompleteTask.Result;
HttpError error = null;

if ((!response.IsSuccessStatusCode) && (response.TryGetContentValue(out error)))
{
    // Build new custom from underlying HttpError object.
    var errorResp = new MyErrorResponse();

    // Replace outgoing response's content with our custom response
    // while keeping the requested MediaType [formatter].
    var content = (ObjectContent)response.Content;
    response.Content = new ObjectContent(typeof (MyErrorResponse), errorResp, content.Formatter);
}

return response;

在哪里:

   public class MyErrorResponse
   {
       public MyErrorResponse()
       { 
          Error = true; 
          Code = 0; 
       }

       public bool Error { get; set; }
       public int Code { get; set; }
   }
于 2013-07-18T20:33:49.720 回答