不正确的json的自定义错误响应。DotNet核心Web API [英] Custom error response for incorrect json. Dotnet Core Web API

问题描述

如果向DotNet Core中的WebApi提供无效类型，是否有返回自定义错误响应的机制？

例如

如果我有一个如下所示的类

public class SomeApiClass
{
    public int Id { get; set; }
}

但像这样发出POST请求(请注意，我期望的是一个int并给出一个字符串)：

{
    "id": "f"
}

则标准DotNet响应如下所示：

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-27be45d9cffab14698524a63120a4f88-6bfe2613f2328a42-00",
    "errors": {
        "$.id": [
            "The JSON value could not be converted to System.Int64. Path: $.wmdaid | LineNumber: 1 | BytePositionInLine: 15."
        ]
    }
}

但是，我希望我对错误请求的所有响应看起来都是一样的，这样实现API的任何人都可以始终得到一致的JSON。我的问题是JSON反序列化是在控制器验证之前完成的。

所以，简而言之，作为DotNet中间件的一部分，是否可以更改此响应格式？

推荐答案

您可以使用自定义ActionFilter。

public class ReformatValidationProblemAttribute : ActionFilterAttribute
{
    public override void OnResultExecuting(ResultExecutingContext context)
    {
        if (context.Result is BadRequestObjectResult badRequestObjectResult)
            if (badRequestObjectResult.Value is ValidationProblemDetails)
            {
                context.Result = new BadRequestObjectResult("Custom Result Here");
            }

        base.OnResultExecuting(context);
    }
}

Controller.cs

[ApiController]
[ReformatValidationProblem]
public class Controller : ControllerBase
{ 
    ...
}

或全局注册 Startup.cs

services.AddMvc(options =>
{
    options.Filters.Add(typeof(ReformatValidationProblemAttribute));
});

这篇关于不正确的json的自定义错误响应。DotNet核心Web API的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！