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

Question

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

例如

如果我有一个 class 看起来像这样

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 中间件的一部分？

Answer 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));
});

Answer 2

您可以实现您的自定义错误模型处理程序，并在每种情况下将其替换为默认的 ModelState 对象，例如错误的请求或... 首先更改服务提供商以注入您的自定义错误 class，如下所示：

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

接下来，我们将创建自定义错误处理程序 Class:

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());  
}

最后，我们想要的自定义错误模型 return:

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

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

Custom error response for incorrect json. Dotnet Core Web API

c#

json

.net-core

json-serialization

.net-5