springdoc - 如何在 Spring Boot 和 Spring doc 中隐藏基于 Profiles 的端点？

Question

我正在研究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 配置文件，我想隐藏部门 API。我们怎么能不呢？

Answer 1

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

• https://springdoc.org/faq.html#how-can-i-define-multiple-openapi-definitions-in-one-spring-boot-project

并且，为组定义添加@Profile 注释和@Bean 注释：这将帮助您根据您的弹簧配置文件显示 OpenAPI 规范

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