学习记录之KNIFE4J

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

基本使用:

1.在项目中添加依赖

注意：以上依赖项仅适用于Spring Boot 2.6（不含）之前的版本。

在配置文件中开启增强模式 ,在`application.properties`中添加：

自定义配置类，实现必要的配置:

创建`Knife4jConfiguration`，并添加配置： 提示：以下配置代码是相对固定的。

使用:

    打开浏览器，输入 http://localhost:8080/doc.html 即可访问。

详细配置:

在控制器类上添加`@Api`注解，配置`tags`属性，可以指定模块名称（API文档中的一级菜单中显示的名称）

在处理请求的方法上添加`@ApiOperation`注解，配置`value`属性，可以指定业务名称（API文档中的一级菜单的子项显示的名称）

在处理请求的方法上添加`@ApiOperationSupport`注解，配置`order`属性，取值为数值，可以指定业务的显示排序序号，将根据`order`属性值升序排列

在处理请求的方法的POJO参数的属性上添加`@ApiModelProperty`注解，配置`value`属性，可以指定参数的说明，另外，还可以通过此注解的`required`属性配置此参数是否必须（并不具备检查功能，只是在API文档上显示为必须提交）