Java SpringBoot关闭线上Swagger
在Spring Boot项目中关闭线上Swagger,可以通过配置文件来实现。你可以在application.properties
或application.yml
中添加相应的配置来禁用Swagger。
如果你使用的是application.properties
文件,可以添加以下配置:
# 禁用Swagger
springfox.documentation.enabled=false
如果你使用的是application.yml
文件,可以添加以下配置:
springfox:
documentation:
enabled: false
这样配置后,Swagger在开发环境可以使用,但在非开发环境(如生产环境)就会被自动关闭。你可以通过设置Spring Boot的spring.profiles.active
属性来切换不同的环境配置。
例如,在生产环境的配置文件(如application-prod.properties
或application-prod.yml
)中,确保开启上述配置。
另外,为了确保生产环境不会意外启用Swagger,你可以在代码中进一步检查环境变量或配置来确保Swagger的关闭。
示例代码(在Swagger配置类中添加判断):
@Configuration
@Profile("!dev") // 不在开发环境中启用
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2).enable(false);
}
}
这段代码中使用了Spring的@Profile
注解,表示除了dev之外的环境中,Swagger都将被禁用。
评论已关闭