第詳解SpringBoot禁用Swagger的三種方式目錄摘要方法禁用方法1：禁用方法2：禁用方法3：

摘要

在生產環(huán)境下，我們需要關閉swagger配置，避免暴露接口的這種危險行為。

方法

禁用方法1：

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

packagecom.dc.config;

importorg.springframework.boot.autoconfigure.condition.ConditionalOnProperty;

importorg.springframework.context.annotation.Bean;

importorg.springframework.context.annotation.Configuration;

importorg.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;

importorg.springframework.web.servlet.config.annotation.ViewControllerRegistry;

importorg.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

importspringfox.documentation.builders.ApiInfoBuilder;

importspringfox.documentation.builders.PathSelectors;

importspringfox.documentation.builders.RequestHandlerSelectors;

importspringfox.documentation.service.ApiInfo;

importspringfox.documentation.service.Contact;

importspringfox.documentation.spi.DocumentationType;

importspringfox.documentation.spring.web.plugins.Docket;

importspringfox.documentation.swagger2.annotations.EnableSwagger2;

*@authorsunnychen

*@versionV1.0

*@Packagecom.dc.config

*@date2025/1/1617:33

*@Description:主要用途：開啟在線接口文檔和添加相關配置

@Configuration

@EnableSwagger2

publicclassSwagger2ConfigextendsWebMvcConfigurerAdapter{

@Value("${swagger.enable}")

privateBooleanenable;

@Bean

publicDocketcreateRestApi(){

returnnewDocket(DocumentationType.SWAGGER_2)

.enable(enable)

.apiInfo(apiInfo())

.select()

.apis(RequestHandlerSelectors.basePackage("com.dc.controller"))

.paths(PathSelectors.any())

//.paths(PathSelectors.none())

.build();

privateApiInfoapiInfo(){

returnnewApiInfoBuilder()

.title("auth系統(tǒng)數據接口文檔")

.description("此系統(tǒng)為新架構Api說明文檔")

.termsOfServiceUrl("")

.contact(newContact("陳永佳chen867647213@163.com","","/Mrs_chens"))

.version("1.0")

.build();

*swaggerui資源映射

*@paramregistry

@Override

publicvoidaddResourceHandlers(ResourceHandlerRegistryregistry){

registry.addResourceHandler("swagger-ui.html")

.addResourceLocations("classpath:/META-INF/resources/");

registry.addResourceHandler("/webjars/**")

.addResourceLocations("classpath:/META-INF/resources/webjars/");

*swagger-ui.html路徑映射，瀏覽器中使用/api-docs訪問

*@paramregistry

@Override

publicvoidaddViewControllers(ViewControllerRegistryregistry){

registry.addRedirectViewController("/api-docs","/swagger-ui.html");

禁用方法2：

使用注解@Profile({“dev”,“test”})

表示在開發(fā)或測試環(huán)境開啟，而在生產關閉。（推薦使用）

packagecom.dc.config;

importorg.springframework.boot.autoconfigure.condition.ConditionalOnProperty;

importorg.springframework.context.annotation.Bean;

importorg.springframework.context.annotation.Configuration;

importorg.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;

importorg.springframework.web.servlet.config.annotation.ViewControllerRegistry;

importorg.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

importspringfox.documentation.builders.ApiInfoBuilder;

importspringfox.documentation.builders.PathSelectors;

importspringfox.documentation.builders.RequestHandlerSelectors;

importspringfox.documentation.service.ApiInfo;

importspringfox.documentation.service.Contact;

importspringfox.documentation.spi.DocumentationType;

importspringfox.documentation.spring.web.plugins.Docket;

importspringfox.documentation.swagger2.annotations.EnableSwagger2;

*@authorsunnychen

*@versionV1.0

*@Packagecom.dc.config

*@date2025/1/1617:33

*@Description:主要用途：開啟在線接口文檔和添加相關配置

@Configuration

@EnableSwagger2

@Profile({“dev”,“test”})

publicclassSwagger2ConfigextendsWebMvcConfigurerAdapter{

@Bean

publicDocketcreateRestApi(){

returnnewDocket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

.select()

.apis(RequestHandlerSelectors.basePackage("com.dc.controller"))

.paths(PathSelectors.any())

//.paths(PathSelectors.none())

.build();

privateApiInfoapiInfo(){

returnnewApiInfoBuilder()

.title("auth系統(tǒng)數據接口文檔")

.description("此系統(tǒng)為新架構Api說明文檔")

.termsOfServiceUrl("")

.contact(newContact("陳永佳chen867647213@163.com","","/Mrs_chens"))

.version("1.0")

.build();

*swaggerui資源映射

*@paramregistry

@Override

publicvoidaddResourceHandlers(ResourceHandlerRegistryregistry){

registry.addResourceHandler("swagger-ui.html")

.addResourceLocations("classpath:/META-INF/resources/");

registry.addResourceHandler("/webjars/**")

.addResourceLocations("classpath:/META-INF/resources/webjars/");

*swagger-ui.html路徑映射，瀏覽器中使用/api-docs訪問

*@paramregistry

@Override

publicvoidaddViewControllers(ViewControllerRegistryregistry){

registry.addRedirectViewController("/api-docs","/swagger-ui.html");

}

禁用方法3：

使用注解@ConditionalOnProperty(name=“swagger.enable”,havingValue=“true”)

然后在測試配置或者開發(fā)配置中添加swagger.enable=true即可開啟，生產環(huán)境不填則默認關閉Swagger.

packagecom.dc.config;

importorg.springframework.boot.autoconfigure.condition.ConditionalOnProperty;

importorg.springframework.context.annotation.Bean;

importorg.springframework.context.annotation.Configuration;

importorg.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;

importorg.springframework.web.servlet.config.annotation.ViewControllerRegistry;

importorg.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

importspringfox.documentation.builders.ApiInfoBuilder;

importspringfox.documentation.builders.PathSelectors;

importspringfox.documentation.builders.RequestHandlerSelectors;

importspringfox.documentation.service.ApiInfo;

importspringfox.documentation.service.Contact;

importspringfox.documentation.spi.DocumentationType;

importspringfox.documentation.spring.web.plugins.Docket;

importspringfox.documentation.swagger2.annotations.EnableSwagger2;

*@authorsunnychen

*@versionV1.0

*@Packagecom.dc.config

*@date2025/1/1617:33

*@Description:主要用途：開啟在線接口文檔和添加相關配置

@Configuration

@EnableSwagger2

@ConditionalOnProperty(name="enabled",prefix="swagger",havingValue="true",matchIfMissing=true)

publicclassSwagger2ConfigextendsWebMvcConfigurerAdapter{

@Bean

publicDocketcreateRestApi(){

returnnewDocket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

.select()

.apis(RequestHandlerSelectors.basePackage("com.dc.controller"))

.paths(PathSelectors.any())

//.paths(PathSelectors.none())

.build();

privateApiInfoapiInfo(){

returnnewApiInfoBuilder()

.title("auth系統(tǒng)數據接口文檔")

.