最近因为使用了swagger集成,当时swagger一般只在dev、sit等环境使用,生产是不建议使用的。
因此对swagger进行,是否使用进行配置。然后就有了一些对@ConditionalOnExpression认识的需要
edu:
swagger:
enable: false
package com.edu.web.common.conf;
import com.edu.common.config.Global;
import io.swagger.annotations.ApiOperation;
import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
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;
/**
* Swagger2的接口配置
*
* @author ChenHuaming
*/
@Configuration
@EnableSwagger2
@ConditionalOnExpression("${edu.swagger.enable:true}")
public class SwaggerConfig {
/**
* 创建API
*/
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
// 详细定制
.apiInfo(apiInfo())
.select()
// 指定当前包路径
// 扫描所有
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.paths(PathSelectors.any())
.build();
}
/**
* 添加摘要信息
*/
private ApiInfo apiInfo() {
// 用ApiInfoBuilder进行定制
return new ApiInfoBuilder()
.title("接口文档")
.description("用于人员查看、调试接口使用")
.contact(new Contact(Global.getName(), null, null))
.version("版本号:" + Global.getVersion())
.build();
}
}
该注解还支持一些java条件判断
@ConditionalOnExpression("${edu.swagger.enable}==1&&${edu.swagger.enable:true}")
字符串也匹配
@ConditionalOnExpression("'${edu.swagger.enable:true}'.equals('used')")
这样配置swagger 如果默认集成了 没有配置,貌似会有个很恶心的弹窗,个人强迫证原因调整了,上面的还是可以使用的
package com.edu.web.common.conf;
import com.edu.common.config.Global;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* Swagger2的接口配置
*
* @author ChenHuaming
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
/**
* 创建API
*/
@Bean
@ConditionalOnProperty(prefix = "edu.swagger", name = "enable", havingValue = "true")
public Docket createDisEnableRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
// 详细定制
.apiInfo(apiInfo())
.select()
// 扫描有ApiOperation的方法
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
.paths(PathSelectors.any())
.build();
}
@Bean
@ConditionalOnProperty(prefix = "edu.swagger", name = "enable", havingValue = "false")
public Docket createEnableRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
// 详细定制
.apiInfo(apiInfo())
.select()
// 扫描有ApiOperation的方法
.apis(RequestHandlerSelectors.none())
.paths(PathSelectors.any())
.build();
}
/**
* 添加摘要信息
*/
private ApiInfo apiInfo() {
// 用ApiInfoBuilder进行定制
return new ApiInfoBuilder()
.title("接口文档")
.description("用于人员查看、调试接口使用")
.contact(new Contact(Global.getName(), null, null))
.version("版本号:" + Global.getVersion())
.build();
}
}
@ConditionalOnProperty 对yml配置兼用会好些
想换工作咯,不知道有没有大佬带走