如何使用 Swashbuckle 从关于 WebAPI 的 Swagger 文档中省略方法

How to omit methods from Swagger documentation on WebAPI using Swashbuckle(如何使用 Swashbuckle 从关于 WebAPI 的 Swagger 文档中省略方法)

问题描述

我有一个 C# ASP.NET WebAPI 应用程序，其中 API 文档是使用 Swashbuckle 自动生成的.我希望能够从文档中省略某些方法，但我似乎无法弄清楚如何告诉 Swagger 不要将它们包含在 Swagger UI 输出中.

I have a C# ASP.NET WebAPI application with API documentation being automatically generated using Swashbuckle. I want to be able to omit certain methods from the documentation but I can't seem to work out how to tell Swagger not to include them in the Swagger UI output.

我觉得这与添加模型或模式过滤器有关，但不清楚该怎么做，文档似乎只提供了如何修改方法输出的示例，而不是将其从输出中完全删除.

I sense it is something to do with adding a model or schema filter but it isn't obvious what to do and the documentation only seems to provide examples of how to modify the output for a method, not remove it completely from the output.

推荐答案

您可以将以下属性添加到 Controllers 和 Actions 以将它们从生成的文档中排除:[ApiExplorerSettings(IgnoreApi = true)]

You can add the following attribute to Controllers and Actions to exclude them from the generated documentation: [ApiExplorerSettings(IgnoreApi = true)]

这篇关于如何使用 Swashbuckle 从关于 WebAPI 的 Swagger 文档中省略方法的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持编程学习网！