api - 与 ModelState 验证 asp.net core api 的行为不一致

Question

当 asp.net core api 验证对象以及手动添加模型错误并调用 BadRequest(ModelState) 时，我得到不一致的行为

例如，我的控制器中有这两个端点

[HttpPost]
public IActionResult Post(MyModel model)
{
    return Ok();
}

[HttpPost]
[Route("test")]
public IActionResult OtherPost()
{
    ModelState.AddModelError("field", "error");
    return BadRequest(ModelState);
}

MyModel 是：

public class MyModel
{
    [Required]
    [MinLength(10)]
    public string MyProperty { get; set; }
}

当我使用空主体调用第一个端点时，我不需要验证 ModelState，因为框架会自动执行它并给出以下响应：

{
"errors":{"MyProperty":["The MyProperty field is required."]},
"title":"One or more validation errors occurred.",
"status":400,
"traceId":"80000005-0000-ff00-b63f-84710c7967bb"
}

使用第二个控制器，我得到了这个：

{"field":["error"]}

我是否使用错误的方法向 ModelState 添加错误，或者这是一个已知问题？

标签： apiasp.net-corebad-request

Answer 1

1. 如果您更喜欢自己验证模型状态并期望得到与绑定失败消息完全相同的结果，则ApiController可以如下所示：

    public IActionResult Other2Post()
    {
        ModelState.AddModelError("field", "error");
        var problemDetails = new ValidationProblemDetails(ModelState)
        {
            Status = StatusCodes.Status400BadRequest,
        };

        var traceId = Activity.Current?.Id ?? HttpContext.TraceIdentifier;
        problemDetails.Extensions["traceId"] = traceId;

        var result = new BadRequestObjectResult(problemDetails);
        result.ContentTypes.Add("application/problem+json");
        result.ContentTypes.Add("application/problem+xml");
        return result;
    }

2. 或者，如果您不需要traceId，您可以简单地返回 a BadRequestof ValidationProblemDetails：

    ModelState.AddModelError("field", "error");
    var problemDetails = new ValidationProblemDetails(ModelState)
    {
        Status = StatusCodes.Status400BadRequest,
    };
    return BadRequest(problemDetails);

演示：

有关更多信息，请参阅此处和此处的相关源代码。