Csharp 在 .NET Core 6 API 中记录自动 HTTP 400 响应

发布于11月16日

[ProducesResponseType(StatusCodes.Status400BadRequest)]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
[ProducesResponseType(StatusCodes.Status500InternalServerError)]
[ProducesResponseType(StatusCodes.Status303SeeOther)]
[HttpPost]
[Route("RegisterUsers")]
public async Task<ActionResult<List<UsersInfo>>> RegisterUsers(List<UsersInfo> Users)
{
    // .. how to detect errors here ...
    return Users;
}

我如何在这里收到错误，特别是当API在Body中收到错误的UserInfo类型格式时？

方法实现永远不会在用户信息类型错误的情况下运行.

推荐答案

这取决于它是Web API还是ASP MVC.

假设您有Web API，[ApiController]属性会使模型验证错误自动触发HTTP400响应. 因此，以下代码在操作方法中是不必要的:

    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }

HTTP 400响应的默认响应类型为ValidationProblemDetails.

如果您需要记录此类自动响应，您可以将InvalidModelStateResponseFactory设置为一个定制函数，该函数首先执行日志(log)记录，然后返回适当的BadRequestObjectResult

例如，您可以try 这样做(参见original documentation)

builder.Services.AddControllers()
    .ConfigureApiBehaviorOptions(options =>
    {
      // To preserve the default behaviour, capture the original delegate to call later.
        var builtInFactory = options.InvalidModelStateResponseFactory;

        options.InvalidModelStateResponseFactory = context =>
        {
            var logger = context.HttpContext.RequestServices
                                .GetRequiredService<ILogger<Program>>();

            // Perform logging here.
            // ...

            // Invoke the default behaviour, which produces a ValidationProblemDetails
            // response.
            // To produce a custom response, return a different implementation of 
            // IActionResult instead.
            return builtInFactory(context);
        };
    });