史上最简单的swagger2整合教程

1.在pom.xml文件中添加Swagger2依赖,具体代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger2</artifactId>

<version>2.2.2</version>

</dependency>

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger-ui</artifactId>

<version>2.2.2</version>

</dependency>

2.添加Swagger2的配置类,代码如下:

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
@Configuration

@EnableSwagger2

public class Swagger2 {

@Bean

public Docket createRestApi() {

return new Docket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

.select()

.apis(RequestHandlerSelectors.basePackage("com.docker.controller"))

.paths(PathSelectors.any())

.build();

}

private ApiInfo apiInfo() {

return new ApiInfoBuilder()

.title("微信电商小程序api相关说明")

.description("微信电商小程序api接口参数说明,函数功能说明")

.termsOfServiceUrl("https://www.wolzq.com/")

.contact("林志强")

.version("1.0")

.build();

}

}

具体参数我不多介绍,大家可去看swagger2的官方文档,这里需要注意的是basePackage这里面的内容,这个是接口包的位置,在这里的意思就是控制类所在的位置。

3.编写含有swagger2的注释的控制类

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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
@Controller

@RequestMapping("api")

public class DockerController {

/**

* 测试docker打包运行是否成功

* @param name

* @return String

*/

@ApiOperation(value="测试docker打包运行是否成功", notes="测试docker打包运行是否成功")

@RequestMapping(value = "docker",method = RequestMethod.GET)

@ResponseBody

public String dockerTest(@ApiParam(value = "用户名称") String name){

return name+":创建docker容器并且运行SpringBoot的jar成功。";

}

/**

* restful中post风格

* @param name

* @return String

*/

@ApiOperation(value="restful中post风格", notes="restful中post风格")

@RequestMapping(value = "docker",method = RequestMethod.GET)

@ResponseBody

public String saveTest(@ApiParam(value = "用户名称") String name){

return name+":restful中post风格。";

}

/**

* restful中put风格

* @param name

* @return String

*/

@ApiOperation(value="restful中put风格", notes="restful中put风格")

@RequestMapping(value = "name",method = RequestMethod.PUT)

@ResponseBody

public String updateTest(@ApiParam(value = "用户名称") String name){

return name+":restful中put风格";

}

/**

* restful中delete风格

* @param name

* @return String

*/

@ApiOperation(value="restful中delete风格", notes="restful中delete风格")

@RequestMapping(value = "name",method = RequestMethod.DELETE)

@ResponseBody

public String deleteTest(@ApiParam(value = "用户名称") String name){

return name+":restful中delete风格。";

}

}

4.最后运行项目,url中输入:http://localhost:8080/swagger-ui.html

就会出现swagger2风格的接口文档出来,如下图所示:





更多内容敬请关注:“林老师带你学编程

林老师带你学编程 wechat
欢迎您扫一扫上面的微信公众号,订阅我的博客!