SpringBoot2.x 整合SpringDoc&Javadoc&knife4j实现无注解零入侵式接口文档
import org.springdoc.core.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
@Configuration
public class SpringDocConfig {
@Bean
public GroupedOpenApi publicApi() {
return GroupedOpenApi.builder()
.group("public")
.pathsToMatch("/api/v1/**")
.build();
}
@Bean
@Profile("!test") // 排除测试环境
public GroupedOpenApi privateApi() {
return GroupedOpenApi.builder()
.group("private")
.pathsToMatch("/api/v1/admin/**")
.build();
}
}
这个配置类定义了两个GroupedOpenApi beans,分别对应"/api/v1/"下的公共接口和"/api/v1/admin/"下的私有接口。通过@Profile
注解,我们可以在不同的环境(如生产和测试)中启用或禁用特定的GroupedOpenApi配置。这样做既保证了文档的安全性,也提高了文档的可维护性。
评论已关闭