.NET8升级后ASP.NET Core WebAPI模型绑定验证未返回ProblemDetails JSON

可能原因及对应解决步骤 #

1. 未配置ApiBehaviorOptions处理模型验证错误 #

.NET 8新建项目默认会自动配置模型验证错误返回ProblemDetails，但升级的旧项目可能保留了旧版的行为配置。需要显式配置ApiBehaviorOptions指定验证失败时的响应格式：

在ConfigureServices中修改AddControllers的配置：

services.AddControllers()
    .ConfigureApiBehaviorOptions(options =>
    {
        // 确保不关闭默认的模型验证过滤器
        options.SuppressModelStateInvalidFilter = false;
        
        // 自定义模型验证失败的响应
        options.InvalidModelStateResponseFactory = context =>
        {
            var validationProblem = new ValidationProblemDetails(context.ModelState)
            {
                Type = "https://tools.ietf.org/html/rfc9110#section-15.5.1",
                Title = "One or more validation errors occurred.",
                Status = StatusCodes.Status400BadRequest,
                Instance = context.HttpContext.Request.Path
            };
            // 添加TraceId
            validationProblem.Extensions.Add("traceId", context.HttpContext.TraceIdentifier);

            return new BadRequestObjectResult(validationProblem)
            {
                ContentTypes = { "application/problem+json" }
            };
        };
    });

2. 自定义过滤器拦截了模型验证响应 #

旧项目可能存在全局或局部的自定义ActionFilter，直接返回了原始错误字符串而非ProblemDetails。检查是否有类似如下的过滤器：

public class ValidateModelFilter : ActionFilterAttribute
{
    public override void OnActionExecuting(ActionExecutingContext context)
    {
        if (!context.ModelState.IsValid)
        {
            // 这种写法会返回原始字符串，需修改
            var errorMsg = string.Join("; ", context.ModelState.Values.SelectMany(v => v.Errors).Select(e => e.ErrorMessage));
            context.Result = new BadRequestObjectResult(errorMsg);
        }
    }
}

解决方式：

• 直接移除该过滤器（[ApiController]特性已自带模型验证处理）；
• 或修改过滤器返回ValidationProblemDetails格式，参考步骤1中的响应构造逻辑。

3. 中间件顺序错误 #

如果项目中存在自定义异常处理中间件，若其注册顺序在UseRouting或UseAuthorization之前，可能会提前拦截模型验证的错误响应，导致无法返回ProblemDetails。

确保中间件顺序符合ASP.NET Core规范：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseRouting();
    app.UseAuthorization();

    // 自定义中间件应放在UseAuthorization之后、MapControllers之前
    // app.UseCustomMiddleware();

    app.MapControllers();
}

4. 兼容性版本设置冲突 #

旧项目可能保留了较低版本的兼容性配置，导致模型验证行为未切换到.NET 8的默认逻辑。检查ConfigureServices中是否有如下代码：

services.AddControllers()
    .SetCompatibilityVersion(CompatibilityVersion.Version_3_0); // 或更早版本

解决方式：移除该行兼容性配置，或设置为最新的兼容版本。

内容的提问来源于stack exchange，提问作者Anomalous Keybasher