03-Knife4j框架

Knife4j框架

Knife4j是一款基于Swagger 2的在线API文档框架。

在Spring Boot中，使用此框架时，需要：

• 添加依赖
• 在配置文件（application.properties）中开启增强模式
• 编写配置类（代码相对固定，建议CV）

关于依赖的代码：

<!-- Knife4j Spring Boot：在线API -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.9</version>
</dependency>

关于开启增强模式，在application.properties中添加：

# 开启Knife4j的增强模式
knife4j.enable=true

完成后，重启项目，打开浏览器，通过 http://localhost:xxxx/doc.html 即可访问Knife4j的API文档。

@Api：添加在控制器类上，配置其tags属性，用于指定模块名称，在指定的模块名称，可以使用数字编号作为名称的前缀，则多个管理模块将按照编号顺序来显示.

@ApiOperation：添加在控制器类中处理请求的方法上，配置其value属性，用于指定业务接口名称.

@ApiOperationSupport：添加在控制器类中处理请求的方法上，配置其order属性，用于指定业务接口的排序编号，最终，同一个模块中的多个业务接口将按此编号升序排列.

@ApiModelProperty：添加在POJO类的属性上，配置其value属性，用于指定请求参数的名称（说明），配置其required属性，用于指定“是否必须提交此请求参数”（仅用于显示，不具备检查功能），配置其example属性，用于指定“示例”.

@ApiImplicitParam：添加在控制器类中处理请求的方法上，配置其name属性，指定方法的参数的变量名，配置其value属性，指定此参数的说明，配置其required属性，指定此参数“是否必须提交”，配置其dataType属性，指定此参数的数据类型.

@ApiImplicitParams：添加在控制器类中处理请求的方法上，当有多个参数需要配置时，使用此注解，且此注解的值是@ApiImplicitParam的数组.

@ApiIgnore：添加在处理请求的方法的参数上，当某个参数不需要显示在API文档中，则需要在参数上添加此注解，例如HttpServletRequest、HttpSession等.