在使用spring-boot開發的時候，我們很多時候會使用swagger作為api文件輸出。可以在UI介面上看到api的路徑，引數等等。

當然，作為開發環境是很方便的，但是上生產環境的時候，我們需要把swagger禁掉。怎麼通過配置檔案的方法來禁用swagger呢？

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * swagger 配置檔案
 * @author cdj
 * @date 2018年7月23日 上午8:51:08
 */
@Configuration
@ConditionalOnProperty(prefix = "swagger",value = {"enable"},havingValue = "true")
@EnableSwagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.edgecdj"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2構建RESTful APIs")
                .description("支付相關demo")
                .termsOfServiceUrl("www.baidu.com")
                .contact("支付相關demo")
                .version("1.0")
                .build();
    }
}

添加註解

@ConditionalOnProperty(prefix = "swagger",value = {"enable"},havingValue = "true")

然後再配置檔案中加入 swagger.enable=true

true為開啟，false或沒有為關閉。

關鍵就是這裡的 @ConditionalOnProperty

這裡的屬性key是 swagger.enable ,havingValue 是期望值，只有在值等於期望值的時候，才會生效。也就是說，swagger.enable只能為true的時候才會生效，其他值或不設值，都不會生效的。