是否有任何集中的方式来限制关于openAPI的api暴露于大范围的ui?

时间:2020-06-25 09:36:37

标签: api swagger openapi springdoc-openapi-ui

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

任何建议将不胜感激。

1 个答案:

答案 0 :(得分: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