使用springfox中的 RequestHandlerSelectors.basePackage("com.xxx") 只能支持单个包路径的扫描匹配,
如果要想支持多个包路径的匹配我们需要修改springfox里面的代码来支持他,现做以下修改来支持多包路径匹配。
-
package com.xxx.swagger;
-
-
import org.springframework.beans.factory.annotation.Value;
-
import org.springframework.context.annotation.Bean;
-
import org.springframework.context.annotation.Configuration;
-
import org.springframework.context.annotation.PropertySource;
-
import org.springframework.context.annotation.PropertySources;
-
-
import springfox.documentation.RequestHandler;
-
import springfox.documentation.builders.ApiInfoBuilder;
-
import springfox.documentation.builders.PathSelectors;
-
import springfox.documentation.service.ApiInfo;
-
import springfox.documentation.spi.DocumentationType;
-
import springfox.documentation.spring.web.plugins.Docket;
-
import springfox.documentation.swagger2.annotations.EnableSwagger2;
-
-
import com.google.common.base.Function;
-
import com.google.common.base.Optional;
-
import com.google.common.base.Predicate;
-
-
/**
-
* Swagger2 UI配置
-
*
-
* <pre>
-
* 通过访问http://your ip:8090/api/swagger-ui.html查看发布的REST接口;
-
* </pre>
-
*
-
* @author 许畅
-
* @since JDK1.7
-
* @version 2017年10月19日 许畅 新建
-
*/
-
-
"classpath:swagger2.properties", ignoreResourceNotFound = true, encoding = "UTF-8") })({ (value =
-
-
public class Swagger2UIConfig {
-
-
/**
-
* 获取API标题
-
*/
-
"${swagger2.title}")(
-
public String title = "Spring Boot中使用Swagger2构建Restful API";
-
-
/**
-
* Swagger2创建Docket的Bean
-
*
-
* @return Docket
-
*/
-
-
public Docket createRestApi() {
-
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
-
.apis(Swagger2UIConfig.basePackage( "com.xxx1,com.xxx2")).paths(PathSelectors.any()).build();
-
}
-
-
/**
-
* Predicate that matches RequestHandler with given base package name for the class of the handler method.
-
* This predicate includes all request handlers matching the provided basePackage
-
*
-
* @param basePackage - base package of the classes
-
* @return this
-
*/
-
public static Predicate<RequestHandler> basePackage(final String basePackage) {
-
return new Predicate<RequestHandler>() {
-
-
-
public boolean apply(RequestHandler input) {
-
return declaringClass(input).transform(handlerPackage(basePackage)).or( true);
-
}
-
};
-
}
-
-
/**
-
* 处理包路径配置规则,支持多路径扫描匹配以逗号隔开
-
*
-
* @param basePackage 扫描包路径
-
* @return Function
-
*/
-
private static Function<Class<?>, Boolean> handlerPackage( final String basePackage) {
-
return new Function<Class<?>, Boolean>() {
-
-
-
public Boolean apply(Class<?> input) {
-
for (String strPackage : basePackage.split( ",")) {
-
boolean isMatch = input.getPackage().getName().startsWith(strPackage);
-
if (isMatch) {
-
return true;
-
}
-
}
-
return false;
-
}
-
};
-
}
-
-
/**
-
* @param input RequestHandler
-
* @return Optional
-
*/
-
private static Optional<? extends Class<?>> declaringClass(RequestHandler input) {
-
return Optional.fromNullable(input.declaringClass());
-
}
-
-
/**
-
* Swagger2创建该Api的基本信息
-
*
-
* @return ApiInfo
-
*/
-
-
public ApiInfo apiInfo() {
-
return new ApiInfoBuilder().title(title)
-
.description( "更多Swagger2配置相关文章请关注:https://springfox.github.io/springfox/docs/current/")
-
.termsOfServiceUrl( "https://springfox.github.io/springfox/docs/current/").version( "1.0").build();
-
}
-
-
}