为什么ModelState返回不同的结果以及如何修复它

Question

Asp.net核心3.1 WebApi。

我有一个具有必需属性的模型。

1.如果模型无效，则响应包含数据类似：

{
"errors": {
"Name": [
"Update model can't have all properties as null."
],
"Color": [
"Update model can't have all properties as null."
]
},
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "|f032f1c9-4c36d1e62aa60ead."
}

这对我来说很好。

但如果我在modelState中添加一些自定义验证。AddModelError("statusId"，"无效订单状态id"(，然后返回不同的结构：

[
{
"childNodes": null,
"children": null,
"key": "statusId",
"subKey": {
"buffer": "statusId",
"offset": 0,
"length": 8,
"value": "statusId",
"hasValue": true
},
"isContainerNode": false,
"rawValue": "11202",
"attemptedValue": "11202",
"errors": [
{
"exception": null,
"errorMessage": "Invalid order status id."
}
],
"validationState": 1
}
]

看起来也像ModelState。对于控制器来说，IsValid不再是实际的，因为坏请求甚至在进入具有无效模式的控制器之前就返回了。或者是否存在通过ModelSate进行全局验证的标志？

为什么结构不同？如何使其相同？如何强制进入ModelState。IsValid方法在api控制器内部，因为它在MVC中工作？

更新：

[Route("....")]
[Authorize]
[ApiController]
public class StatusesController : ApiControllerBase
{

[HttpPut, Route("{statusId}")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
[ProducesResponseType(StatusCodes.Status409Conflict)]
[Produces("application/json")]
public async Task<ObjectResult> UpdateStatusAsync(int statusId, [FromBody] StatusUpdateDto orderStatusUpdateDto)
{
int companyId = User.Identity.GetClaimValue<int>(ClaimTypes.CompanyId);
const string errorNotFound  = "There is not order status with this id for such company";
if (statusId <= 0)
{
Logger.LogError(errorNotFound);
ModelState.AddErrorModel(nameof(statusId), "Invalid order status id")
throw new NotFound(ModelState);
}

if (orderStatusUpdateDto == null)
{
const string error = "Invalid (null) order status can't be added";
Logger.LogError(error);
throw new ArgumentNullException(error);
}
if (ModelState.IsValid == false) // also this code is always true or returns 400 before this line
{
return BadRequest(ModelState); 
}
....
return result;
}
}

Answer 1

ApiController属性为控制器添加了一些特定的固执己见的行为。其中之一是，如果模型无效，则返回400错误。此行为可以被禁用，但只能在全局级别上禁用。

services.AddControllers()
.ConfigureApiBehaviorOptions(options =>
{
options.SuppressModelStateInvalidFilter = true;
});

我认为你有以下选择：

• 禁用此行为并亲自检查ModelState.IsValid。使用ValidationProblem方法产生相同的响应
• 将此检查添加到模型的验证器
• 保持一切原样。但是在控制器方法中使用ValidationProblem来返回验证错误

请参阅https://learn.microsoft.com/en-us/aspnet/core/web-api/?view=aspnetcore-3.1#自动-http-400-信息响应