在为整数参数发送非整数值后，ASP.NET Web API 2 在请求上为空

Question

我有一个关于 Asp.net Web Api 2 的项目。在测试其中一个端点时，我遇到了 .net 框架的一种有趣行为。

这是端点的简化版本：

    [Route("api/v1/bookings/documenttype/{clientId}/{companyCode}/{year}")]
    [HttpGet]
    [ResponseType(typeof(IEnumerable<UserVoucherType>))]
    public IHttpActionResult GetUserDocumentTypes(int clientId, string companyCode, 
                                                  int year, [FromUri] int? month = null)
    {
        //Do Some work
        return Ok();
    }

这里的问题是当我发送一个非整数值作为 'month' 参数的值而不是收到错误请求或类似的东西时，我在运行时得到 null，这会导致问题。例如，端点的一个消费者正在发送 '[1,2,3]' 并获取全年的所有数据，而不是收到错误消息。

例如，对于这个请求，我得到的值低于我在 ss 上指出的值： http://localhost:64652/api/v1/bookings/documenttype/1/0001/2019?month=[1,2,3]

现在我的问题是，我如何才能针对这样的案例返回错误的请求。

月份参数是可选的，我无法在端点上理解消费者是否故意发送此参数为空，或者他们发送的参数值无效。

有这个设置吗？我正在考虑编写一个自定义参数活页夹，但这不是过度工程吗？我认为框架的行为应该是默认返回错误请求还是我遗漏了什么？

Answer 1

您可以为可选参数创建一个模型并将 Range 属性应用于月份。

（这是.NET5，所以我使用[FromQuery]，但这也适用于[FromUri]）

public OkResult GetUserDocumentTypes(int clientId, string companyCode, 
                                            int year, [FromQuery] GetUserDocumentTypesOptionalInput optional)
{
//Do Some work
    return Ok();
}

public class GetUserDocumentTypesOptionalInput 
{
    [Range(1, 12, ErrorMessage = "Invalid month")]
    public int? Month {get; set; } // 1 or 0 based? 
}

如果您必须手动检查ModelState.IsValid 来捕获错误，这将取决于您的配置。

---

此外，<TargetFramework>net5.0</TargetFramework> 和 [FromQuery] int? month = null 将返回以下错误：

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-65615fa2ff03a141b2cd80d7fc4f9dca-db45cf7466ae6f4f-00",
    "errors": {
        "month": [
            "The value '[1,2,3]' is not valid."
        ]
    }
}

Answer 2

您可以更改 Route 属性以包含数据类型约束。

[Route("api/v1/bookings/documenttype/{clientId}/{companyCode}/{year:int{min:2000}/{month:int?}")]

我添加了 2 个约束 - 月份和年份的数据类型，以及年份的最小值。

更多详情请参考the official documentation from Microsoft.