ASP.NET Core API模型绑定类型不匹配时返回自定义响应

我之前也碰到过类似的需求——把ASP.NET Core API中因数据类型不匹配（比如字符串绑定到GUID参数失败）导致的模型绑定错误响应，替换成自定义内容。其实通过配置ApiBehaviorOptions就能轻松实现，具体做法如下：

核心实现：替换默认的InvalidModelStateResponseFactory #

在你的Program.cs（.NET 6+）或者Startup.cs（.NET 5及更早版本）中，通过依赖注入配置ApiBehaviorOptions，替换它的InvalidModelStateResponseFactory方法，以此自定义模型绑定失败时的响应内容。

代码示例 #

builder.Services.Configure<ApiBehaviorOptions>(options =>
{
    options.InvalidModelStateResponseFactory = context =>
    {
        // 检查是否存在数据类型转换类的错误（比如字符串转GUID失败）
        bool hasTypeConversionError = context.ModelState.Values
            .Any(modelStateEntry => 
                modelStateEntry.Errors.Any(error => 
                    error.Exception is FormatException 
                    || error.ErrorMessage.Contains("Error converting value")));

        if (hasTypeConversionError)
        {
            // 返回自定义的"processing error"响应，状态码保持400 Bad Request
            return new ObjectResult("processing error")
            {
                StatusCode = StatusCodes.Status400BadRequest
            };
        }

        // 对于其他类型的ModelState错误（比如必填项缺失），可以保留默认响应
        return new BadRequestObjectResult(context.ModelState);
    };
});

更精准的GUID转换错误判断 #

如果你只想针对GUID类型的绑定失败返回自定义响应，可以把错误判断逻辑改得更精准：

bool hasGuidConversionError = context.ModelState.Values
    .Any(modelStateEntry => 
        modelStateEntry.Errors.Any(error => 
            error.Exception is FormatException formatEx 
            && formatEx.TargetSite.DeclaringType == typeof(Guid)));

原理说明 #

ASP.NET Core API默认会在模型绑定失败时，通过InvalidModelStateResponseFactory生成包含详细错误信息的响应。我们通过替换这个工厂方法，就能拦截这类错误，根据自己的需求返回自定义内容。

这样配置后，当用户提交的字符串无法转换为GUID时，API就会直接返回"processing error"，而不是默认的详细错误JSON了。

内容的提问来源于stack exchange，提问作者Praveen Rao Chavan.G