Spring Boot 禁用 Swagger 的三种方式(1)

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门，即可获取！
@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(“陈永佳 chen867647213@163.com”, “”, “https://blog.csdn.net/Mrs_chens”))

.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 sunny chen

• @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(“陈永佳 chen867647213@163.com”, “”, “https://blog.csdn.net/Mrs_chens”))

.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.

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 sunny chen

• @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();

最后

看完上述知识点如果你深感Java基础不够扎实，或者刷题刷的不够、知识不全面

小编专门为你量身定制了一套<Java一线大厂高岗面试题解析合集：JAVA基础-中级-高级面试+SSM框架+分布式+性能调优+微服务+并发编程+网络+设计模式+数据结构与算法>

针对知识面不够，也莫慌！还有一整套的<Java核心进阶手册>，可以瞬间查漏补缺

全都是一丢一丢的收集整理纯手打出来的

更有纯手绘的各大知识体系大纲，可供梳理：Java筑基、MySQL、Redis、并发编程、Spring、分布式高性能架构知识、微服务架构知识、开源框架知识点等等的xmind手绘图~

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门，即可获取！
，也莫慌！还有一整套的<Java核心进阶手册>，可以瞬间查漏补缺

[外链图片转存中…(img-xJjds4YF-1714656356521)]

全都是一丢一丢的收集整理纯手打出来的

更有纯手绘的各大知识体系大纲，可供梳理：Java筑基、MySQL、Redis、并发编程、Spring、分布式高性能架构知识、微服务架构知识、开源框架知识点等等的xmind手绘图~

[外链图片转存中…(img-x2rks0Go-1714656356522)]

[外链图片转存中…(img-Zids6HFu-1714656356522)]
《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门，即可获取！