Spring Boot 禁用 Swagger 的三种方式,想搞清楚ZooKeepe
在Spring Boot项目中,你可以通过以下几种方式来禁用Swagger。
- 在
application.properties
或application.yml
配置文件中禁用Swagger。
# application.properties
springfox.documentation.enabled=false
# application.yml
springfox:
documentation:
enabled: false
- 通过Java配置来禁用Swagger。
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.data.rest.configuration.SpringDataRestConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class SwaggerConfig {
@Bean
public SpringDataRestConfiguration springDataRestConfiguration() {
return new SpringDataRestConfiguration() {
@Override
public boolean isEnabled() {
return false;
}
};
}
}
- 如果你使用的是Spring profiles,可以在启动应用时指定不启用Swagger的profile。
import org.springframework.context.annotation.Profile;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@EnableSwagger2
@Profile("!swagger-off")
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2);
}
}
启动应用时使用命令行参数来指定profile:
java -jar your-application.jar --spring.profiles.active=swagger-off
以上就是在Spring Boot项目中禁用Swagger的几种方式。需要注意的是,禁用Swagger会影响到API文档的可用性,因此在实际应用中需要根据具体情况选择合适的禁用方式。
评论已关闭