SpringBoot禁用Swagger的方式有哪些

这篇文章主要介绍“SpringBoot禁用swagger的方式有哪些”，在日常操作中，相信很多人在springBoot禁用Swagger的方式有哪些问题上存在疑惑，小编查阅了各式资料，整理出简单好用的操作方法，希望对大家解答”SpringBoot禁用Swagger的方式有哪些”的疑惑有所帮助！接下来，请跟着小编一起来学习吧！

摘要

在生产环境下，我们需要关闭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;@Configuration@EnableSwagger2public 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();    }        @Override    public void addResourceHandlers(ResourceHandlerRegistry registry) {        registry.addResourceHandler("swagger-ui.html")                .addResourceLocations("classpath:/META-INF/resources/");        registry.addResourceHandler("/webjars    @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;@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();    }        @Override    public void addResourceHandlers(ResourceHandlerRegistry registry) {        registry.addResourceHandler("swagger-ui.html")                .addResourceLocations("classpath:/META-INF/resources/");        registry.addResourceHandler("/webjars    @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;@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("陈永佳 chen867647213@163.com", "", "https://blog.csdn.net/Mrs_chens"))                .version("1.0")                .build();    }        @Override    public void addResourceHandlers(ResourceHandlerRegistry registry) {        registry.addResourceHandler("swagger-ui.html")                .addResourceLocations("classpath:/META-INF/resources/");        registry.addResourceHandler("/webjars    @Override    public void addViewControllers(ViewControllerRegistry registry) {        registry.addRedirectViewController("/api-docs","/swagger-ui.html");    }}

到此，关于“SpringBoot禁用Swagger的方式有哪些”的学习就结束了，希望能够解决大家的疑惑。理论与实践的搭配能更好的帮助大家学习，快去试试吧！若想继续学习更多相关知识，请继续关注编程网网站，小编会继续努力为大家带来更多实用的文章！