说说Knife4j

Knife4j是一款基于Swagger2的在线API文档框架

使用Knife4j, 需要

· 添加Knife4j的依赖

当前建议使用的Knife4j版本, 只适用于Spring Boot2.6以下版本, 不含Spring Boot2.6

· 在主配置文件(application.yml)中开启Knife4j的增强模式

必须在主配置文件中进行配置, 不要配置在个性化配置文件中

· 添加Knife4j的配置类, 进行必要的配置

必须指定控制器的包

关于依赖项的代码:

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

在application.yml中添加配置:

knife4j:enable: true

在根包下创建config.Knife4jConfiguration配置类:

package cn.tedu.csmall.passport.config;import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;/*** Knife4j配置类** @author [e-mail]* @version 0.0.1*/
@Slf4j
@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {/*** 【重要】指定Controller包路径*/private String basePackage = "cn.tedu.csmall.passport.controller";/*** 分组名称*/private String groupName = "passport";/*** 主机名*/private String host = "http://java.tedu.cn";/*** 标题*/private String title = "酷鲨商城在线API文档--管理员管理";/*** 简介*/private String description = "酷鲨商城在线API文档--管理员管理";/*** 服务条款URL*/private String termsOfServiceUrl = "http://www.apache.org/licenses/LICENSE-2.0";/*** 联系人*/private String contactName = "Java教学研发部";/*** 联系网址*/private String contactUrl = "http://java.tedu.cn";/*** 联系邮箱*/private String contactEmail = "[e-mail]";/*** 版本号*/private String version = "1.0.0";@Autowiredprivate OpenApiExtensionResolver openApiExtensionResolver;public Knife4jConfiguration() {log.debug("加载配置类：Knife4jConfiguration");}@Beanpublic Docket docket() {String groupName = "1.0.0";Docket docket = new Docket(DocumentationType.SWAGGER_2).host(host).apiInfo(apiInfo()).groupName(groupName).select().apis(RequestHandlerSelectors.basePackage(basePackage)).paths(PathSelectors.any()).build().extensions(openApiExtensionResolver.buildExtensions(groupName));return docket;}private ApiInfo apiInfo() {return new ApiInfoBuilder().title(title).description(description).termsOfServiceUrl(termsOfServiceUrl).contact(new Contact(contactName, contactUrl, contactEmail)).version(version).build();}}

完成后, 启动项目, 通过 http://localhost:9081/doc.html 即可访问在线API文档!

关于Knife4j的在线API文档, 可以通过一系列注解来配置此文件的显示:

• @Api：添加在控制器类上，通过此注解的tags属性，可以指定模块名称，并且，在指定名称时，建议在名称前添加数字作为序号，Knife4j会根据这些数字将各模块升序排列，例如：

@Api(tags = "01. 管理员管理模块")

• @ApiOpearation：添加在控制器类中处理请求的方法上，通过此注解的value属性，可以指定业务/请求资源的名称，例如：

@ApiOperation("添加管理员")

• @ApiOperationSupport：添加在控制器类中处理请求的方法上，通过此注解的order属性（int），可以指定排序序号，Knife4j会根据这些数字将各业务/请求资源升序排列，例如：

@ApiOperationSupport(order = 100)

关于@RequestBody

在Spring MVC框架中，在处理请求的方法的参数前：

• 当添加了@RequestBody注解，则客户端提交的请求参数必须是对象格式的，例如：

{"name": "小米11的相册","description": "小米11的相册的简介","sort": 88}

如果客户端提交的数据不是对象，而是FormData格式的，在接收到请求时将报错：

org.springframework.web.HttpMediaTypeNotSupportedException: Content type 'application/x-www-form-urlencoded;charset=UTF-8' not supported

• 当没有添加@RequestBody注解，则客户端提交的请求参数必须是FormData格式的，例如：

name=小米11的相册&description=小米11的相册的简介&sort=88

如果客户端提交的数据不是FormData格式的，而是对象，则无法接收到参数（不会报错，控制器中各参数值为null）

另外，Knife4j框架的调试界面中，如果是对象格式的参数（使用了@RequestBody），将不会显示各请求参数的输入框，而是提供一个JSON字符串供编辑，如果是FormData格式的参数（没有使用@RequestBody），则会显示各请求参数对应的输入框。

通常，更建议使用FormData格式的请求参数！则在控制器处理请求的方法的参数上不需要添加@RequestBody注解！

在Vue脚手架项目中，为了更便捷的使用FormData格式的请求参数，可以在项目中使用qs框架，此框架的工具可以轻松的将JavaScript对象转换成FormData格式！

则在前端的Vue脚手架项目中，先安装qs：

npm i qs -S

然后，在main.js中添加配置：

import qs from 'qs';Vue.prototype.qs = qs;

最后，在提交请求之前，可以将对象转换成FormData格式，例如：

let formData = this.qs.stringify(this.ruleForm);console.log('formData：' + formData);

如果处理请求时，参数是封装的POJO类型，需要对各请求参数进行说明时，应该在此POJO类型的各属性上使用@ApiModelProperty注解进行配置，通过此注解的value属性配置请求参数的名称，通过requeired属性配置是否必须提交此请求参数（并不具备检查功能），例如：

需要注意，@ApiModelProperty还可以用于配置响应时的各数据！

对于处理请求的方法的参数列表中那些未封装的参数（例如String、Long），需要在处理请求的方法上使用@ApiImplicitParam注解来配置参数的说明，并且，必须配置name属性，此属性的值就是方法的参数名称，使得此注解的配置与参数对应上，然后，再通过value属性对参数进行说明，还要注意，此属性的required属性表示是否必须提交此参数，默认为false，即使是用于配置路径上的占位符参数，一旦使用此注解，required默认也会是false，则需要显式的配置为true，另外，还可以通过dataType配置参数的数据类型，如果未配置此属性，在API文档中默认显示为string，可以按需修改为int、long等。例如：

如果处理请求的方法上有多个未封装的参数，则需要使用多个@ApiImplicitParam注解进行配置，并且，这多个@ApiImplicitParam注解需要作为@ApiImplicitParams注解的参数，例如：