knife4j配置多个扫描多个模块下的包
开始我的思路是使用通配符,就像配置mybatis的包扫描那样.结果好像不行,
错误的示范:
@Bean(value = "defaultApi2")
public Docket defaultApi2() {
Docket docket=new Docket(DocumentationType.SWAGGER_2)
.apiInfo(new ApiInfoBuilder()
//.title("swagger-bootstrap-ui-demo RESTful APIs")
.description("# swagger-bootstrap-ui-demo RESTFul APIs")
.termsOfServiceUrl("http://www.xx.com/")
.version("1.0")
.build())
//分组名称
.groupName("2.X版本")
.select()
//这里指定Controller扫描包路径
.apis(basePackage(
"com.aluphy.**.controller"
// "com.aluphy.material.controller"+splitor+"com.aluphy.user.controller"
))
.apis(basePackage(
"com.aluphy"
// "com.aluphy.material.controller"+splitor+"com.aluphy.user.controller"
))
// .apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
return docket;
}
主要看下边这块
.apis(basePackage("com.aluphy.**.controller")
正确的做法:
使用多个controller共同拥有的父包,这就要求我们在创建不同的模块的时候,起包的名字的时候要求统一了
比如我有两个模块 material 和 user,他们的目录结构如下:
此时就可以配置为下边这样就可以了
package com.aluphy.config;
import com.google.common.base.Function;
import com.google.common.base.Optional;
import com.google.common.base.Predicate;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class Knife4jConfiguration {
// 定义分隔符,配置Swagger多包
private static final String splitor = ";";
@Bean(value = "defaultApi2")
public Docket defaultApi2() {
Docket docket=new Docket(DocumentationType.SWAGGER_2)
.apiInfo(new ApiInfoBuilder()
//.title("swagger-bootstrap-ui-demo RESTful APIs")
.description("# swagger-bootstrap-ui-demo RESTFul APIs")
.termsOfServiceUrl("http://www.xx.com/")
.version("1.0")
.build())
//分组名称
.groupName("2.X版本")
.select()
//这里指定Controller扫描包路径
.apis(basePackage(
"com.aluphy"
// "com.aluphy.material.controller"+splitor+"com.aluphy.user.controller"
))
.apis(basePackage(
"com.aluphy"
// "com.aluphy.material.controller"+splitor+"com.aluphy.user.controller"
))
// .apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
return docket;
}
public static Predicate<RequestHandler> basePackage(final String basePackage) {
return input -> declaringClass(input).transform(handlerPackage(basePackage)).or(true);
}
private static Function<Class<?>, Boolean> handlerPackage(final String basePackage) {
return input -> {
// 循环判断匹配
for (String strPackage : basePackage.split(splitor)) {
boolean isMatch = input.getPackage().getName().startsWith(strPackage);
if (isMatch) {
return true;
}
}
return false;
};
}
private static Optional<? extends Class<?>> declaringClass(RequestHandler input) {
return Optional.fromNullable(input.declaringClass());
}
}
主要看下边这块
.apis(basePackage("com.aluphy"))
这样就OK了,你学废了么