当前位置：首页 > news >正文

springBoot如何【禁用Swagger】

news 2025/7/6 4:02:41

需求：

生产环境下，需要关闭swagger配置，避免接口暴露。

方法：

1、使用注解@Value()
2、使用注解@Profile({“dev”,“test”}) 表示在开发或测试环境开启，而在生产关闭。
3、使用注解@ConditionalOnProperty(name = “swagger.enable”, havingValue = “true”) 然后在测试配置或者开发配置中添加 swagger.enable = true 即可开启，生产环境不填则默认关闭Swagger。

方法一：使用注解@Value()

在Swagger2Config类里添加；
并需要在配置文件里添加一个swagger.enable属性，根据不同的application-xx.yml进行动态插入true或false即可。

@Configuration
@EnableSwagger2
public class Swagger2Config {@Value("${swagger.enable}")private Boolean enable;@Beanpublic Docket swaggerPersonApi10() {return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.basePackage("com.unidata.cloud.logservice.api.controller")).paths(PathSelectors.any()).enable(enable)    //配置在该处生效.build().apiInfo(apiInfo());}private ApiInfo apiInfo() {return new ApiInfoBuilder().version("1.0").title("xx项目：xx平台 Swagger2 文档 API").contact(new Contact("  xx团队", "https://www.xx.com/", "kangjia@xx.com")).description("logservice platform API v1.0").build();}
}

方法二：使用注解@Profile({“dev”,“test”}) 表示在开发或测试环境开启，而在生产关闭。

@Configuration
@EnableSwagger2
@Profile({"local", "dev"})
public class Swagger2Config {@Beanpublic Docket swaggerPersonApi10() {return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.basePackage("com.unidata.cloud.logservice.api.controller")).paths(PathSelectors.any()).build().apiInfo(apiInfo());}private ApiInfo apiInfo() {return new ApiInfoBuilder().version("1.0").title("xx项目：xx平台 Swagger2 文档 API").contact(new Contact("  xx团队", "https://www.xx.com/", "kangjia@xx.com")).description("logservice platform API v1.0").build();}
}

方法三：使用注解@ConditionalOnProperty(name = “swagger.enable”, havingValue = “true”) 然后在测试配置或者开发配置中添加 swagger.enable = true 即可开启，生产环境不填则默认关闭Swagger。

1、使用注解 @ConditionalOnProperty(name = “swagger.enable”, havingValue = “true”)

@Configuration
@EnableSwagger2
//@ConditionalOnProperty(name ="enabled" ,prefix = "swagger",havingValue = "true",matchIfMissing = true   //matchIfMissing=true :为空则设为true,不合理
@ConditionalOnProperty(name = “swagger.enable”, havingValue = “true”)
public class Swagger2Config {@Beanpublic Docket swaggerPersonApi10() {return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.basePackage("com.unidata.cloud.logservice.api.controller")).paths(PathSelectors.any()).enable(enable).build().apiInfo(apiInfo());}private ApiInfo apiInfo() {return new ApiInfoBuilder().version("1.0").title("xx项目：xx平台 Swagger2 文档 API").contact(new Contact("  xx团队", "https://www.xxx.com/", "kangjia@xxx.com")).description("logservice platform API v1.0").build();}
}