错误 json 的自定义错误响应。点网核心 Web API

Posted 2023-04-12

【中文标题】错误 json 的自定义错误响应。点网核心 Web API

【英文标题】：Custom error response for incorrect json. Dotnet Core Web API

【发布时间】：2021-09-29 18:34:08

【问题描述】：

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

例如

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

public class SomeApiClass

    public int Id  get; set; 

但是发出这样的帖子请求（注意我期待一个 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 中间件的一部分？

【问题讨论】：

您需要替换 JSON 请求的默认模型绑定器/输入格式化程序，以在错误消息到达控制器操作之前拦截并替换错误消息。 docs.microsoft.com/en-us/aspnet/core/mvc/models/…

【参考方案1】：

您可以使用自定义 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));
);

【讨论】：

我是否可以在整个 API 套件中执行此操作？还是我必须在每个类上指定属性？

【参考方案2】：

您可以实现自定义错误模型处理程序，并在每种情况下将其替换为默认 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;          
  

【讨论】：

这似乎是在验证类的模型状态。问题是返回的错误出现在模型状态之前