Knife4j是什么?

1.  Knife4j简介

        Knife4j是基于SpringBoot构建的一个文档生成工具，它可以让开发者为我们的应用生成API文档；

        目的是可以更加方便的基于API文档进行测试。

        生成的文档还可以导出，然后给到前端开发团队，前端开发团队可以基于API接口写具体的调用。

2.  Knife4j优点

        Knife4j 功能强大，易于操作。

        Knife4j 的UI界面非常美观，使用流畅。

        Knife4j 可以高度定制化，让其符合你的项目需求。

3.  Knife4j快速上手

        3.1 pom.xml添加依赖

        3.2 配置Swagger的相关信息

        3.3 查看生成的接口文档

4. 常用注解应用分析

        4.1 @Api注解:添加在控制器类上的注解；通过此注解的tags属性可以修改原本显示控制器类名称的位置的文本；

        4.2 @ApiOperation注解:添加在控制器类中处理请求的方法上的注解；用于配置此方法处理的请求在API文档中显示的文本。

        4.3 @ApiModelProperty注解:是添加在POJO类的属性上的注解；用于对请求参数或响应结果中的某个属性进行说明；主要通过其value属性配置描述文本，并可通过example属性配置示例值。

        4.4 @ApiImplicitParam注解:添加在控制器类中处理请求的方法上的注解；主要用于配置非封装的参数。

        4.5 @ApiImplicitParams注解:添加在控制器类中处理请求的方法上的注解；当方法有多个非封装的参数时，在方法上添加此注解，并在注解内部通过@ApiImplicitParam数组配置多个参数。

        4.6 @ApiIgnore注解:添加在处理请求的方法的参数上；用于表示API文档框架应该忽略此参数。

5. 限制请求方式

        API文档中默认每个功能会展示7种请求方式，遵循RESTful规则将 `@RequestMapping` 注解修改为对应请求方法的注解，比如：`@GetMapping  @PostMapping  @PutMapping  @DeleteMapping` 注解，重启工程后刷新测试。

6. 导出离线API文档

        6.1 文档管理 - 离线文档 中存在多种格式的导出格式

        6.2 选择合适的文档格式，导出即可到本地磁盘