Spring Boot 禁用 Swagger 的三种方式

这篇文章距离上次修改已过212天，其中的内容可能已经有所变动。

在Spring Boot项目中，你可以通过以下几种方式来禁用Swagger。

方式一：在application.properties或application.yml配置文件中添加以下配置。

# application.properties
springfox.documentation.enabled=false

# application.yml
springfox:
  documentation:
    enabled: false

方式二：通过Java配置来禁用Swagger。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.data.rest.configuration.SpringDataRestConfiguration;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2).enable(false).select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

方式三：如果你使用的是Spring Boot 2.x版本，可以在启动类中禁用Swagger。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.spring.web.SpringfoxWebMvcConfiguration;

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    // 禁用Swagger
    @Bean
    public SpringfoxWebMvcConfiguration swaggerWebMvcConfiguration() {
        return new SpringfoxWebMvcConfiguration() {
            @Override
            protected void addResourceHandlers(ResourceHandlerRegistry registry) {
                registry.addResourceHandler("swagger-ui.html")
                        .addResourceLocations("classpath:/META-INF/resources/");
                registry.addResourceHandler("/webjars/**")
                        .addResourceLocations("classpath:/META-INF/resources/webjars/");
            }
        };
    }
}

以上三种方式均可以禁用Swagger，你可以根据自己的项目情况选择适合的方式来禁用Swagger。

Spring Boot 禁用 Swagger 的三种方式

评论已关闭

推荐阅读