Knife4jConfig.java
2.39 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
package com.canrd.webmagic.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
import java.util.ArrayList;
import java.util.List;
/**
* knife4j配置信息
*/
@Configuration
@EnableSwagger2WebMvc // 启用swagger支持
public class Knife4jConfig {
@Bean
public Docket adminApiConfig(){
List<Parameter> pars = new ArrayList<>();
ParameterBuilder tokenPar = new ParameterBuilder();
tokenPar.name("token")
.description("用户token")
.defaultValue("")
.modelRef(new ModelRef("string"))
.parameterType("header")
.required(false)
.build();
pars.add(tokenPar.build());
//添加head参数end
Docket webMagicApi = new Docket(DocumentationType.SWAGGER_2)
.groupName("adminApi")
.apiInfo(adminApiInfo())
.select()
// 设置扫描的控制器包 第一层过滤
.apis(RequestHandlerSelectors.any())
// .apis(RequestHandlerSelectors.basePackage("org.canrd"))
// //只显示admin路径下的页面 第二层过滤
.paths(PathSelectors.any())
.build()
.globalOperationParameters(pars);
return webMagicApi;
}
// 定义文档的说明 标题 联系人 版本号 联系邮箱
private ApiInfo adminApiInfo(){
return new ApiInfoBuilder()
.title("爬虫-API文档")
.description("本文档描述了爬虫系统微服务接口定义")
.version("1.0")
.contact(new Contact("凌世锦", "http://qq.com", "1187551704@qq.com"))
.build();
}
}