如何在WebAPI上使用Swashbuckle省略Swagger文档中的方法

25 浏览
0 Comments

如何在WebAPI上使用Swashbuckle省略Swagger文档中的方法

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

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

admin 更改状态以发布 2023年5月23日
0

2 答案

0 Comments

在开发（调试）过程中，可能会有帮助，我们喜欢暴露整个控制器和/或操作，然后在生产（发布构建）时隐藏它们。 \n

#if DEBUG
    [ApiExplorerSettings(IgnoreApi = false)]
#else
    [ApiExplorerSettings(IgnoreApi = true)]
#endif

0
0 Comments

您可以在控制器和操作上添加以下属性，以将它们排除在生成的文档之外：[ApiExplorerSettings(IgnoreApi = true)]

0