如何修改ASP.NET Core Web API类型不匹配参数的默认处理行为？

这个问题我之前也碰到过，ASP.NET Core默认的模型绑定行为确实会把无法转换的参数设为类型默认值，不过有几种方法可以修改这个行为，让参数类型不匹配时直接返回400错误：

方法1：用[ApiController]特性自动处理模型验证 #

这是最简单的方案，只要给你的控制器加上[ApiController]特性，ASP.NET Core就会自动检查模型绑定的有效性，一旦发现参数类型不匹配（比如length=a转int失败），就会直接返回400 Bad Request响应，附带详细的错误信息。

修改后的控制器代码示例：

[ApiController]
[Route("api/v1/[controller]")]
public class OrdersController : ControllerBase
{
    [HttpGet("list")]
    public List<Order> List([FromQuery] int index = 0, [FromQuery] int length = 100)
    {
        return GetOrders(index, length);
    }

    // 你的GetOrders方法实现...
}

当请求https://localhost:5000/api/v1/Orders/list?index=0&length=a时，会收到类似这样的响应：

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "0HMBG71K2A9AH:00000001",
  "errors": {
    "length": [
      "The value 'a' is not valid for length."
    ]
  }
}

方法2：手动检查ModelState（不依赖ApiController） #

如果因为项目限制不能使用[ApiController]，可以在Action开头手动验证ModelState的有效性，发现错误就返回BadRequest：

[HttpGet("list")]
public IActionResult List([FromQuery] int index = 0, [FromQuery] int length = 100)
{
    // 检查模型绑定是否有错误
    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }
    return Ok(GetOrders(index, length));
}

注意这里要把Action的返回类型从List<Order>改成IActionResult（或者ActionResult<List<Order>>），这样才能灵活返回错误响应。

方法3：用可空类型+[Required]注解强化验证 #

如果你希望参数必须提供有效的值，不能依赖默认值，可以把参数改成可空类型，再加上[Required]注解。这样当参数无法转换时会被设为null，触发[Required]的验证规则，进而返回400错误：

[HttpGet("list")]
public List<Order> List([FromQuery, Required] int? index = 0, [FromQuery, Required] int? length = 100)
{
    // 验证通过后可以安全地获取非空值
    return GetOrders(index.Value, length.Value);
}

这种方式不仅能拦截类型不匹配的情况，还能强制要求参数必须存在（如果不需要强制必填，去掉[Required]即可，此时只有类型不匹配时才会报错）。

自定义错误响应格式（可选） #

如果需要统一API的错误响应格式，可以在Program.cs里配置ApiBehaviorOptions，自定义模型验证失败时的返回内容：

builder.Services.Configure<ApiBehaviorOptions>(options =>
{
    options.InvalidModelStateResponseFactory = context =>
    {
        var problemDetails = new ValidationProblemDetails(context.ModelState)
        {
            Type = "https://your-api-domain.com/problems/invalid-params",
            Title = "无效的请求参数",
            Status = StatusCodes.Status400BadRequest,
            Detail = "部分请求参数格式不正确，请检查后重试",
            Instance = context.HttpContext.Request.Path
        };

        return new BadRequestObjectResult(problemDetails);
    };
});

内容的提问来源于stack exchange，提问作者Sigurd Garshol