api - 是否有任何集中的方法来限制 api 在 openAPI 方面对 ui 的暴露？

Question

我刚刚从 springfox 迁移到 spring-doc openAPI，现在它在我的 spring-boot 项目中公开了我们所有的 api 以获取文档。是否有任何集中的方式来管理该事情，因为在我们的情况下使用 @Hidden 注释是不可行的，因为我们必须修改我们的所有控制器。

任何建议将不胜感激。

Answer 1

您可以使用：

springdoc.paths-to-exclude带有字符串列表的属性。要排除的路径列表（逗号分隔）

或springdoc.packages-to-exclude带有字符串列表的属性。要排除的包列表（逗号分隔）。

或者您可以使用 spring-boot 配置文件动态加载组。请注意，对于这种用法，您不必声明 GroupedOpenApi Bean。您需要在前缀 springdoc.group-configs 下声明以下属性。

springdoc.group-configs[0].group=users
springdoc.group-configs[0].paths-to-match=/user/**
springdoc.group-configs[0].packages-to-scan=test.org.springdoc.api