SpringBoot 通过配置禁用swagger

转自：https://blog.csdn.net/weixin_37264997/article/details/82762050

一、序言

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

二、方法：

禁用方法1：

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

 package com.dc.config;

 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
 import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
 import springfox.documentation.builders.ApiInfoBuilder;
 import springfox.documentation.builders.PathSelectors;
 import springfox.documentation.builders.RequestHandlerSelectors;
 import springfox.documentation.service.ApiInfo;
 import springfox.documentation.service.Contact;
 import springfox.documentation.spi.DocumentationType;
 import springfox.documentation.spring.web.plugins.Docket;
 import springfox.documentation.swagger2.annotations.EnableSwagger2;

 /**
  * @author zhaohp
  * @version V1.0
  * @Package com.dc.config
  * @date 2018/1/16 17:33
  * @Description: 主要用途：开启在线接口文档和添加相关配置
  */
 @Configuration
 @EnableSwagger2
 public class Swagger2Config extends WebMvcConfigurerAdapter {

     @Value("${swagger.enable}")
     private Boolean enable;

     @Bean
     public Docket createRestApi() {
         return new Docket(DocumentationType.SWAGGER_2)
                 .enable(enable)
                 .apiInfo(apiInfo())
                 .select()
                 .apis(RequestHandlerSelectors.basePackage("com.dc.controller"))
                 .paths(PathSelectors.any())
                 //.paths(PathSelectors.none())
                 .build();
     }

     private ApiInfo apiInfo()  {
         return new ApiInfoBuilder()
                 .title("auth系统数据接口文档")
                 .description("此系统为新架构Api说明文档")
                 .termsOfServiceUrl("")
                 .contact(new Contact("赵化鹏  18310695431@163.com", "", "zhaohuapeng@zichan360.com"))
                 .version("1.0")
                 .build();
     }

     /**
      * swagger ui资源映射
      * @param registry
      */
     @Override
     public void addResourceHandlers(ResourceHandlerRegistry registry) {
         registry.addResourceHandler("swagger-ui.html")
                 .addResourceLocations("classpath:/META-INF/resources/");

         registry.addResourceHandler("/webjars/**")
                 .addResourceLocations("classpath:/META-INF/resources/webjars/");
     }

     /**
      * swagger-ui.html路径映射，浏览器中使用/api-docs访问
      * @param registry
      */
     @Override
     public void addViewControllers(ViewControllerRegistry registry) {
         registry.addRedirectViewController("/api-docs","/swagger-ui.html");
     }
 }

禁用方法2：

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

 package com.dc.config;

 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
 import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
 import springfox.documentation.builders.ApiInfoBuilder;
 import springfox.documentation.builders.PathSelectors;
 import springfox.documentation.builders.RequestHandlerSelectors;
 import springfox.documentation.service.ApiInfo;
 import springfox.documentation.service.Contact;
 import springfox.documentation.spi.DocumentationType;
 import springfox.documentation.spring.web.plugins.Docket;
 import springfox.documentation.swagger2.annotations.EnableSwagger2;

 /**
  * @author zhaohp
  * @version V1.0
  * @Package com.dc.config
  * @date 2018/1/16 17:33
  * @Description: 主要用途：开启在线接口文档和添加相关配置
  */
 @Configuration
 @EnableSwagger2
 @Profile({“dev”,“test”})
 public class Swagger2Config extends WebMvcConfigurerAdapter {

     @Bean
     public Docket createRestApi() {
         return new Docket(DocumentationType.SWAGGER_2)
                 .apiInfo(apiInfo())
                 .select()
                 .apis(RequestHandlerSelectors.basePackage("com.dc.controller"))
                 .paths(PathSelectors.any())
                 //.paths(PathSelectors.none())
                 .build();
     }

     private ApiInfo apiInfo()  {
         return new ApiInfoBuilder()
                 .title("auth系统数据接口文档")
                 .description("此系统为新架构Api说明文档")
                 .termsOfServiceUrl("")
                 .contact(new Contact("赵化鹏  18310695431@163.com", "", "zhaohuapeng@zichan360.com"))
                 .version("1.0")
                 .build();
     }

     /**
      * swagger ui资源映射
      * @param registry
      */
     @Override
     public void addResourceHandlers(ResourceHandlerRegistry registry) {
         registry.addResourceHandler("swagger-ui.html")
                 .addResourceLocations("classpath:/META-INF/resources/");

         registry.addResourceHandler("/webjars/**")
                 .addResourceLocations("classpath:/META-INF/resources/webjars/");
     }

     /**
      * swagger-ui.html路径映射，浏览器中使用/api-docs访问
      * @param registry
      */
     @Override
     public void addViewControllers(ViewControllerRegistry registry) {
         registry.addRedirectViewController("/api-docs","/swagger-ui.html");
     }
 }

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

关键就是这里的 @ConditionalOnProperty

这里的属性key是 swagger.enable ,havingValue 是期望值，只有在值等于期望值的时候，才会生效。也就是说，swagger.enable只能为true的时候才会生效，其他值或不设值，都不会生效的。

 package com.dc.config;

 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
 import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
 import springfox.documentation.builders.ApiInfoBuilder;
 import springfox.documentation.builders.PathSelectors;
 import springfox.documentation.builders.RequestHandlerSelectors;
 import springfox.documentation.service.ApiInfo;
 import springfox.documentation.service.Contact;
 import springfox.documentation.spi.DocumentationType;
 import springfox.documentation.spring.web.plugins.Docket;
 import springfox.documentation.swagger2.annotations.EnableSwagger2;

 /**
  * @author zhaohp
  * @version V1.0
  * @Package com.dc.config
  * @date 2018/1/16 17:33
  * @Description: 主要用途：开启在线接口文档和添加相关配置
  */
 @Configuration
 @EnableSwagger2
 @ConditionalOnProperty(name ="enabled" ,prefix = "swagger",havingValue = "true",matchIfMissing = true)
 public class Swagger2Config extends WebMvcConfigurerAdapter {

     @Bean
     public Docket createRestApi() {
         return new Docket(DocumentationType.SWAGGER_2)
                 .apiInfo(apiInfo())
                 .select()
                 .apis(RequestHandlerSelectors.basePackage("com.dc.controller"))
                 .paths(PathSelectors.any())
                 //.paths(PathSelectors.none())
                 .build();
     }

     private ApiInfo apiInfo()  {
         return new ApiInfoBuilder()
                 .title("auth系统数据接口文档")
                 .description("此系统为新架构Api说明文档")
                 .termsOfServiceUrl("")
                 .contact(new Contact("赵化鹏  18310695431@163.com", "", "zhaohuapeng@zichan360.com"))
                 .version("1.0")
                 .build();
     }

     /**
      * swagger ui资源映射
      * @param registry
      */
     @Override
     public void addResourceHandlers(ResourceHandlerRegistry registry) {
         registry.addResourceHandler("swagger-ui.html")
                 .addResourceLocations("classpath:/META-INF/resources/");

         registry.addResourceHandler("/webjars/**")
                 .addResourceLocations("classpath:/META-INF/resources/webjars/");
     }

     /**
      * swagger-ui.html路径映射，浏览器中使用/api-docs访问
      * @param registry
      */
     @Override
     public void addViewControllers(ViewControllerRegistry registry) {
         registry.addRedirectViewController("/api-docs","/swagger-ui.html");
     }
 }