Spring Boot 禁用 Swagger 的三种方式

Posted 2023-04-27

参考技术A 在生产环境下，我们需要关闭swagger配置，避免暴露接口的这种危险行为。

使用注解 @Value() 推荐使用

使用注解 @Profile(“dev”,“test”) 表示在开发或测试环境开启，而在生产关闭。（推荐使用）

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

Spring boot 配置 swagger

1、maven配置包

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>

2、配置类

@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo")) //这里改成你报controller报名即可
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {

        return new ApiInfoBuilder()
                .title("RESTful APIs")
                .description("RESTFul API 文档")
                .version("1.0")
                .build();
    }
}

3、访问地址： http://localhost:8080/swagger-ui.html

 

官方使用说明：http://springfox.github.io/springfox/docs/current/