如何基于Spring Boot和Spring文档中的个人资料隐藏端点?

时间:2020-06-18 10:37:42

标签: springdoc springdoc-openapi-ui springdoc-ui

我正在研究Spring Boot v2.2.2.RELEASE and SpringDoc UI and Open API Specification OAS3,在这里发现了一个非常相关的问题:https://github.com/springdoc/springdoc-openapi/issues/201

我有4个个人资料,分别说Dev,Stage,UAT和Prod,说我有Student API,Employee API和Department API。

我想要UAT和Prod配置文件,我想隐藏Department API。我们怎么能不呢?

1 个答案:

答案 0 :(得分:1)

您可以使用组:在组中声明每个API。

然后,为组定义添加@Profile注释和@Bean注释:这将帮助您根据您的spring概要文件显示OpenAPI规范

@Bean
@Profile("!prod")
public GroupedOpenApi actuatorApi() {
    return GroupedOpenApi.builder().group("Actuator")
            .pathsToMatch("/actuator/**")
            .pathsToExclude("/actuator/health/*")
            .build();
}