没有 HTTP 动词的 ASP.NET Core 错误处理程序引发 Swashbuckle 异常

Question

在错误处理的文档中有这样的：

警告
不要使用 HTTP 方法属性标记错误处理程序操作方法，例如 HttpGet。 显式动词会阻止某些请求到达操作方法。

所以它推荐这个：

[ApiController]
public class ErrorController : ControllerBase
{
    //[HttpGet]           <-- docs say not to do this
    [Route("/error")]
    public IActionResult Error() => Problem();
}

但是，当我遵循该建议（而不是[HttpGet("/error")] ）时，我从 Swashbuckle 收到此错误：

Swashbuckle.AspNetCore.SwaggerGen.SwaggerGeneratorException：操作的 HTTP 方法不明确 - ErrorController.Error。 操作需要 Swagger/OpenAPI 3.0 的显式 HttpMethod 绑定

显然，当我包含动词时，它会起作用。

有人可以在文档中解释该建议背后的原因吗？

Answer 1

文档中建议的原因是允许任何类型的 HTTP 请求在发生错误时到达错误处理程序。 例如，如果您将其标记为[HttpGet] ，它将无法处理 POST 请求中的错误。

为了[ApiExplorerSettings(IgnoreApi = true)]与 Swagger 配合使用，您可以使用以下属性标记控制器（甚至特定操作）： [ApiExplorerSettings(IgnoreApi = true)]

这将导致 Swashbuckle 不为其生成元数据，也不会在 Swagger UI 中显示它。