修改.net ApiController "BadResult()"打印自定义JSON

本文关键字：quot 打印 自定义 JSON net 修改 BadResult ApiController | 更新日期: 2023-09-27 18:01:18

我使用。net模式，其中我的控制器动作具有这样的签名

public async Task<IHttpActionResult> GetTimeSeries(string deviceId, string tag) { ... }

和控制器内部，我想发送一个自定义错误消息坚持JSON API规范

我的目标是当遇到错误时使用 
return BadRequest(someJSONErrorObject);

或

return NotFound(someJSONErrorObject);

而不是抛出异常。

当前如果我做

return BadRequest(JsonConvert.SerializeObject(someJSONErrorObject));
返回的JSON看起来像 
{
"Message": "{'"data'":null,'"errors'":[{'"detail'":'"The string was not recognized as a valid DateTime. There is an unknown word starting at index 0.'"}],'"meta'":null}"
}

修改.net ApiController "BadResult()"打印自定义JSON

创建自定义IHttpActionResult 

public class CustomResponseResult<T> : IHttpActionResult {
    public CustomResponseResult(HttpStatusCode statusCode, T content, HttpRequestMessage request) {
        Content = content;
        Request = request;
        StatusCode = statusCode;
    }
    public T Content { get; private set; }
    public HttpRequestMessage Request { get; private set; }
    public HttpStatusCode StatusCode { get; private set; }
    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken) {
        return Task.FromResult(Execute());
    }
    private HttpResponseMessage Execute() {
        var response = Request.CreateResponse(StatusCode, Content);
        response.RequestMessage = Request;
        response.ReasonPhrase = StatusCode.ToString();
        return response;
    }
}
然后为了保持可用性，创建扩展方法 
public static class ApiControllerExtensions {
    public static IHttpActionResult BadRequest<T>(this ApiController controller, T content) {
        return controller.CustomResponse(HttpStatusCode.BadRequest, content);
    }
    public static IHttpActionResult NotFound<T>(this ApiController controller, T content) {
        return controller.CustomResponse(HttpStatusCode.NotFound, content);
    }
    public static IHttpActionResult CustomResponse<T>(this ApiController controller, HttpStatusCode statusCode, T content) {
        var request = controller.Request;
        var result = new CustomResponseResult<T>(statusCode, content, request);
        return result;
    }
}

允许所需的调用

return this.BadRequest(someJSONErrorObject);

或

return this.NotFound(someJSONErrorObject);

创建自定义错误类，其中可以设置http状态和错误消息。创建自定义异常类以抛出自定义错误消息。创建一个全局异常过滤器，它将发送json格式的自定义异常。

相关文章：