不正确的 json 的自定义错误响应 Dotnet 核心 Web API

如何解决不正确的 json 的自定义错误响应 Dotnet 核心 Web API

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

例如

如果我有一个看起来像这样的课程

ping

但是像这样发出一个post请求（注意我期待一个int并给出一个字符串）：

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

那么标准的 dotnet 响应如下所示：

{
    "id": "f"
}

但是，我希望我的所有响应对于错误请求看起来都一样，这样任何实现 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));
});

,

您可以实现自定义错误模型处理程序，并在每个场景（例如错误请求或...）中将其替换为默认的 ModelState 对象。 首先更改服务提供者以注入您的自定义错误类，如下所示：

services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2)    
  .ConfigureApiBehaviorOptions(options => {      
   options.InvalidModelStateResponseFactory = actionCtx => {  
    return CustomBadRequestHandler(actionCtx);  
   };  
  });  

接下来，我们将创建我们的自定义错误处理程序类：

private BadRequestObjectResult CustomBadRequestHandler(ActionContext actionCtx) {      
 return new BadRequestObjectResult(actionCtx.ModelState  
  .Where(modelError => modelError.Value.Errors.Count > 0)  
  .Select(modelError => new Error {  
   ErrorFieldKey = modelError.Key,ErrorDescription = modelError.Value.Errors.FirstOrDefault().ErrorMessage  
  }).ToList());  
} 

最后，我们想要返回的自定义错误模型：

public class Error    
{    
    //your custom filed that you want to show
    public string ErrorFieldKey { get; set; }    
    public string ErrorDescription { get; set; }         
}