控制器操作错误的 Swagger 响应属性答案

【问题标题】：Swagger Response Attributes for Controller Action Errors控制器操作错误的 Swagger 响应属性
【发布时间】：2021-08-08 14:53:03
【问题描述】：

我正在努力使用我的C# web api 中的控制器操作错误来查找SwaggerResponse 属性的一些示例，例如NotFound() 等。

我的控制器方法上有这个属性：

[SwaggerResponse(404, "Requested application not found", Type = typeof(NotFoundResult))]

在控制器方法中我有这个：

NotFound("No configuration found")

但是在 UI 中我得到了这个：

我希望它至少会显示 json 中的代码，而不是 0？

在 UI 中唯一看起来合理的是 200 响应，这是一个 List<settings>，它显示列表，但不显示示例。

【问题讨论】：

标签： swagger-ui swashbuckle

【解决方案1】：

在最终得到正确的搜索词后，我在这里找到了一个答案，它实际上将所有错误模型都抑制了，这比在您的文档中包含上述内容要好。

使用 net5.0 这对我有用：

// add controllers with swagger
services.AddControllers(x => x.Conventions.Add(new ApiExplorerVersionConvention()))
    .ConfigureApiBehaviorOptions(x => { x.SuppressMapClientErrors = true; });

有关旧 .Net 版本的更多信息，请参见此处：

Hide Swagger Bad Response for .net 2.2

【讨论】：