SpringBoot在生产快速禁用Swagger2的方法步骤

下面我将介绍使用SpringBoot在生产环境中快速禁用Swagger2的方法。

步骤一：pom.xml中排除Swagger2依赖

在pom.xml文件中，可以使用如下代码排除Swagger2依赖：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>${swagger.version}</version>
    <exclusions>
        <exclusion>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-annotations</artifactId>
        </exclusion>
        <exclusion>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-models</artifactId>
        </exclusion>
        <exclusion>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-core</artifactId>
        </exclusion>
    </exclusions>
</dependency>

如上代码所示，使用exclusions标签可以排除Swagger2依赖的swagger-annotations、swagger-models和swagger-core等三个Jar包。

示例1：排除Swagger2依赖

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- Swagger2依赖 -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>
    <!-- 集成Swagger2 UI -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

<!-- 排除Swagger2依赖，保留Swagger3依赖 -->
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
            <exclusions>
                <exclusion>
                    <groupId>io.swagger</groupId>
                    <artifactId>swagger-annotations</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>io.swagger</groupId>
                    <artifactId>swagger-models</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>io.swagger</groupId>
                    <artifactId>swagger-core</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>
</dependencyManagement>

示例2：排除Swagger2依赖，保留Swagger3依赖

步骤二：在生产环境中禁用Swagger2

将Swagger2的文档生成和UI接口禁用是非常重要的，因为它们可能会暴露系统的敏感信息。以下是禁用Swagger2的方法：

使用@Configuration注解自定义一个配置类，重新定义一个Docket的bean实例，然后设置它的enable属性为false。代码如下：

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .enable(false);
    }
}

如上代码所示，enable属性被设置为false，禁用了Swagger2。

示例1：禁用Swagger2

@Configuration
@EnableSwagger2
public class Swagger2Config {

    /**
     * 配置Swagger2文档
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo"))
                .paths(PathSelectors.any())
                .build()
                .enable(false);    // 禁用Swagger2
    }

    /**
     * 配置文档信息
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SpringBoot Demo接口文档")
                .description("这是一个Swagger2 UI的示例文档")
                .contact(new Contact("Lynn", "", "[e-mail]"))
                .version("1.0")
                .build();
    }
}

示例2：禁用Swagger2