SpringBoot Swagger 禁用/启用配置

文章目录集成pom.xmlapplication.properties配置类禁用配置项访问效果集成pom.xml<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</ve

锦天

10676人浏览 · 2021-06-06 15:07:17

锦天 · 2021-06-06 15:07:17 发布

文章目录

集成

pom.xml

<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger2</artifactId>
	<version>2.9.2</version>
</dependency>
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger-ui</artifactId>
	<version>2.9.2</version>
</dependency>

application.properties

swagger.enable=true

配置类

package com.wuyujin.msdemo.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;

/**
 * Description config swagger-ui
 * access address rule: portocol://ip:port/appName/swagger-ui.html
 * sample： http://localhost:8888/ms/swagger-ui.html
 *
 * @ClassName com.wuyujin.msdemo.config.SwaggerConfig
 * @Version 1.0
 * @Date: 2021/6/6 2:22 下午
 * @User leung
 * @Author yujin.wu@outlook.com
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    // Boolean 优于 boolean (必须要存在该配置项，否则启动报错)
    @Value("${swagger.enable}")
    private Boolean enable;

    @Bean
    public Docket createRestApi(){
        Docket docker = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(this.apiInfo())
                .enable(enable)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
        return docker;
    }

    private ApiInfo apiInfo(){
        String title = "ms-demo api documents";
        String description = "这是一个demo项目";

        String name = "wyj";
        String url = "http://www.wuyujin.com";
        String email = "yujin.wu@outlook.com";

        ApiInfo apiInfo = new ApiInfoBuilder()
                .title(title)
                .description(description)
                .version("1.0")
                .contact(new Contact(name, url, email))
                .build();
        return apiInfo;
    }

}