阳光沙滩博客系统-集成Swagger2-ui
# 添加swagger依赖
<!-- RESTful APIs swagger2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
添加配置文件
@Configuration
@EnableSwagger2
public class Swagger2Configuration {
//版本
public static final String VERSION = "1.0.0";
/**
* 门户api，接口前缀：portal
*
* @return
*/
@Bean
public Docket portalApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(portalApiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("net.sunofbeach.blog.controller.portal"))
.paths(PathSelectors.any()) // 可以根据url路径设置哪些请求加入文档，忽略哪些请求
.build()
.groupName("前端门户");
}
private ApiInfo portalApiInfo() {
return new ApiInfoBuilder()
.title("阳光沙滩博客系统门户接口文档") //设置文档的标题
.description("门户接口文档") // 设置文档的描述
.version(VERSION) // 设置文档的版本信息-> 1.0.0 Version information
.build();
}
/**
* 管理中心api，接口前缀：admin
*
* @return
*/
@Bean
public Docket adminApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(adminApiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("net.sunofbeach.blog.controller.admin"))
.paths(PathSelectors.any()) // 可以根据url路径设置哪些请求加入文档，忽略哪些请求
.build()
.groupName("管理中心");
}
private ApiInfo adminApiInfo() {
return new ApiInfoBuilder()
.title("阳光沙滩管理中心接口文档") //设置文档的标题
.description("管理中心接口") // 设置文档的描述
.version(VERSION) // 设置文档的版本信息-> 1.0.0 Version information
.build();
}
@Bean
public Docket UserApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(userApiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("net.sunofbeach.blog.controller.user"))
.paths(PathSelectors.any()) // 可以根据url路径设置哪些请求加入文档，忽略哪些请求
.build()
.groupName("用户中心");
}
private ApiInfo userApiInfo() {
return new ApiInfoBuilder()
.title("阳光沙滩博客系统用户接口") //设置文档的标题
.description("用户接口的接口") // 设置文档的描述
.version(VERSION) // 设置文档的版本信息-> 1.0.0 Version information
.build();
}
}
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
66
67
68
69
70
71
72
73
74
75
76
77
78
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
66
67
68
69
70
71
72
73
74
75
76
77
78
# 访问地址
localhost:端口号/swagger-ui.html
编辑 (opens new window)