(二十五)ATP应用测试平台——springboot集成knife4j实现API接口文档说明

前言

原生的swagger文档虽然也可以作为API文档输出，但是不够简洁优美，本节内容我们主要介绍一下knife4j组件，该组件是对swagger API文档的二次封装，使用API文档更加简洁明了，无论是入参还是结果响应，都有清晰的说明，而且可以保留缓存，方便刷新文档后继续保留之前的操作。

正文

①添加knife4j的maven依赖，以springboot启动器的方式

<dependency>
	<groupId>com.github.xiaoymin</groupId>
	<artifactId>knife4j-openapi2-spring-boot-starter</artifactId>
	<version>4.0.0</version>
</dependency>

 ②开启knife4j组件的配置，在application.yml中配置knife4j的相关配置

knife4j:
  enable: true
  openapi:
    title: HT-ATP官方文档
    description: "ATP"
    email: beicang@foxmail.com
    concat: beicang
    url: https://docs.xiaominfo.com
    version: v4.0
    license: Apache 2.0
    license-url: http://127.0.0.1:7777/doc.html
    terms-of-service-url: http://127.0.0.1:7777/doc.html
    group:
      test1:
        group-name: atp
        api-rule: package
        api-rule-resources:
          - com.ht.atp.plat.controller #扫描的文档路径

 ③添加restful风格的API接口用于测试接口文档

@Api(tags = "app管理")
@RestController
@RequestMapping("/app")
@Slf4j
public class AppController {
    @Autowired
    private AppService appService;

    @ApiOperation(value = "app应用列表查询")
    @GetMapping(value = "page")
    public Result<Page<App>> page(@ApiParam(name = "pageNum", value = "当前页")
                                  @RequestParam(value = "pageNum",defaultValue = "1") Integer pageNum,
                                  @ApiParam(name = "pageSize", value = "每页记录数")
                                  @RequestParam(value = "pageSize",defaultValue = "10") Integer pageSize) {
        IPage ipage = new Page<>().setCurrent(pageNum).setSize(pageSize);
        IPage page = appService.page(ipage);
        return Result.success(page);
    }

}

 ④启动spring项目,访问接口文档http://127.0.0.1:7777/doc.html#/home

⑤查看API接口文档说明

⑥ API接口调试及响应结果

 ⑦swagger文档doc

结语

本节内容到这里就结束了，下期见。。。