测试文章

文章目录

一、SpringBoot依赖和实例代码准备
二、配置和页面展示
三、测试
四、主要注解
（一）@Api
（二）@ApiOperation
（三）@ApiIgnore

一、SpringBoot依赖和实例代码准备

本实例基于SpringBoot搭建，所需要的配置和依赖很少，下面添加主要的依赖

<dependency>

<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>1.9.6</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-web</artifactId>
</dependency>

1
2
3
4
5
6
7
8
9

上面已经添加了相关的依赖，下面构建controller包，应对于项目开发，这里准备俩个不同的controller，其中admin标识后台controller接口，user标识前台应用的controller
在这里插入图片描述
其中controller里面的内容如下，注意需要有controller相关注解标注

/[youtube]**
* @Author zhangyu
* @Date 2020/6/15
* @Description
**/
@RequestMapping(“/admin/user”)
@RestController
public class AdminUserRestController {
@GetMapping(“/add”)
public ApiResponse add() {
return ApiResponse.ofSuccess(“add”);[/youtube]
}
@GetMapping(“/delete”)
public ApiResponse delete() {
return ApiResponse.ofSuccess(“delete”);
}
@GetMapping(“/update”)
public ApiResponse update() {
return ApiResponse.ofSuccess(“update”);
}
@GetMapping(“/list”)
public ApiResponse list() {
return ApiResponse.ofSuccess(“list”);
}
}

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

其中ApiResponse就是后端返回前端的响应类Result
二、配置和页面展示

上面已经准备了基本的API接口，下面进行swagger的配置

/**
* @Author zhangyu
* @Date 2020/6/15
* @Description
**/

@Configuration
@EnableSwagger2
@[infobox title=”标题内容”]EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
@ConditionalOnProperty(value = {“knife4j.enable”}, matchIfMissing = true)
public class Swagger2Config {[/infobox]

/**
* 前台API分组
*
* @return
*/
@Bean(value = “indexApi”)
public Docket indexApi() {
return new Docket(DocumentationType.SWAGGER_2)
.groupName(“前台API分组”)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage(“com.example.swagger.user”))
.paths(PathSelectors.any())
.build();
}

/**
* 后台API分组
*
* @return
*/
@Bean(value = “adminApi”)
public Docket adminApi() {
return new Docket(DocumentationType.SWAGGER_2)
.groupName(“后台API分组”)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage(“com.example.swagger.admin”))
.paths(PathSelectors.any())
.build();