ToB企服应用市场:ToB评测及商务社交产业平台

标题: SprongBoot3整合Knife4j [打印本页]
作者: 商道如狼道    时间: 2024-7-1 19:40
标题: SprongBoot3整合Knife4j
大家好，我是晓凡。
写在前面

在上一篇文章，我们具体介绍了SpringBoot3  怎么整合SpringDoc实现在线接口文档。但是，有不少小伙伴
都以为接口界面太丑了。有没有什么更雅观一点的UI界面呢？
当然是有的了，毕竟这是一个看脸的期间，Knife4j 这不来了么。
一、界面比较

这儿我们将上一篇文章使用swagger UI 和Knife4j UI做一个比较，哪个好看就不消我多说了吧。
① swaggerUI界面

②Knife4j UI界面

二、Knife4j 是什么？

Knife4j 是一个为 Java 项目天生和管理 API 文档的工具。实际上，它是 Swagger UI的一个增强工具集，
旨在让 Swagger 天生的 API在线文档更加优雅、雅观、强大。
① 官方地点
http://knife4j.net/
②文档地点
https://doc.xiaominfo.com/docs/quick-start
三、为什么要使用Knife4j

使用Knife4j重要有以下优点，就问哪个不吸引我们呢？
四、Knife4j版本介绍

现在，我们使用的SpringBoot 版本重要是2和3,不同的boot版本需要适配不同版本的Knife4j.
通过这一小节，我们将在项目中选择合适的Knife4j版本
4.1 Knife4j的宿世此生

在更名为Knife4j之前,原来的名称是叫swagger-bootstrap-ui，这是两种不一样风格的Ui,区别如下
名称开发语言&框架状态最后版本风格Knife4jJava、JavaScript、Vue持续更新中...无玄色swagger-bootstrap-uiJava、JavaScript、jQuery停更1.9.6蓝色Knife4j从开源至今,现在重要经历版本的厘革，分别如下：
版本阐明1.0~1.9.6名称是叫swagger-bootstrap-ui,蓝色风格Ui1.9.6蓝色皮肤风格,开始更名，增加更多后端模块2.0~2.0.5Ui基于Vue2.0+AntdV重写,玄色风格，底层依赖的springfox2.9.2,仅提供Swagger2规范的适配2.0.6~2.0.9底层依赖springfox2.10.5,仅提供Swagger2规范的适配3.0~3.0.3底层依赖springfox3.0.3,是太过版本，不建议使用4.0~Knife4j对于支持不同协议,依赖的是第三方组件，需要引入不同依赖
OpenAPI2(Swagger2)规范，依赖Springfox项目,项目处于停更状态，不建议使用
OpenAPI3(Swagger3)规范，依赖Springdoc项目，更新频率快，建议使用该版本4.2 Spring Boot版本兼容性

Spring Boot版本Knife4j Swagger2规范Knife4j OpenAPI3规范1.5.x~2.0.0=Knife4j 4.0.02.0~2.2Knife4j 2.0.0 ~ 2.0.6>=Knife4j 4.0.02.2.x~2.4.0Knife4j 2.0.6 ~ 2.0.9>=Knife4j 4.0.02.4.0~2.7.x>=Knife4j 4.0.0>=Knife4j 4.0.0>= 3.0>=Knife4j 4.0.0>=Knife4j 4.0.0如果你不考虑使用Knife4j提供的服务端增强功能，引入Knife4j的纯Ui版本没有任何限定。只需要考虑不同的规范即可
五、快速开始

通过上面的介绍，相信你已经对Knife4j 有了团体的认识，接下来我们就使用SpringBoot3快速整合Knife4j。
我们这选用的情况如下
5.1 新建一个web项目

建一个名为knife4j-spring-boot3-demo 的web项目，项目结构如下

5.2 添加Knife4j 依赖

⚠️温馨提示
我们这里使用的是SpringBoot3
  1. <dependency>
  2.     <groupId>com.github.xiaoymin</groupId>
  3.     <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
  4.     <version>4.4.0</version>
  5. </dependency>
复制代码
5.3 新建hello接口

新建controller包，添加HelloController类，代码如下
  1. @RestController
  2. public class HelloController {
  3.     @GetMapping("/hello")
  4.     public String hello(){
  5.         return "hello";
  6.     }
  7. }
复制代码
5.4 访问Knife4j在线文档

浏览器输入：http://localhost:8080/doc.html  访问在线接口文档

六、Knife4j 常用设置

⚠️温馨提示：
增强功能需要通过设置application.yml设置文件开启增强，背面不再赘述，默认开启
  1. knife4j:
  2. enable: true
复制代码
6.1 项目设置

在application.yml中可以自界说api-docs和swagger-ui的访问路径。当然了，如果没设置，默认就是下面路径
注：这儿还是兼容swagger ui页面展示
  1. springdoc:
  2.   swagger-ui:
  3.     path: /swagger-ui.html
  4.     tags-sorter: alpha
  5.     operations-sorter: alpha
  6.   api-docs:
  7.     path: /v3/api-docs
  8.   group-configs:
  9.     - group: 'default'
  10.       paths-to-match: '/**'
  11.       packages-to-scan: com.xiezhr.knife4jspringboot3demo.controller
复制代码
浏览器输入：http://localhost:8080/swagger-ui/index.html 可按照原来ui来显示

6.2 设置接口文档基本信息

① 设置接口基本信息
新建一个config包--->并在包下创建一个Knife4jConfig设置类

② 设置接口文档基础信息
这儿我们可以设置接口文档标题、接口文档版本信息、接口文档描述信息、接口文档接洽人信息，接口文档license允许证信息
我们只需在设置类中添加如下代码即可
  1. @Configuration
  2. public class Knife4jConfig {
  4.     @Bean
  5.     public OpenAPI openAPI() {
  6.         return new OpenAPI()
  7.                 // 配置接口文档基本信息
  8.                 .info(this.getApiInfo())
  9.                 ;
  10.     }
  12.     private Info getApiInfo() {
  13.         return new Info()
  14.                 // 配置文档标题
  15.                 .title("SpringBoot3集成Knife4j")
  16.                 // 配置文档描述
  17.                 .description("SpringBoot3集成Knife4j示例文档")
  18.                 // 配置作者信息
  19.                 .contact(new Contact().name("程序员晓凡").url("https://www.xiezhrspace.cn").email("1666397814@163.com"))
  20.                 // 配置License许可证信息
  21.                 .license(new License().name("Apache 2.0").url("https://www.xiezhrspace.cn"))
  22.                 // 概述信息
  23.                 .summary("SpringBoot3集成Knife4j示例文档aaa")
  24.                 .termsOfService("https://www.xiezhrspace.cn")
  25.                 // 配置版本号
  26.                 .version("2.0");
  27.     }
  28. }
复制代码
浏览器输入：http://localhost:8080/doc.html 访问显示如下



6.3 i18n国际化

Knife4j提供了i18n的支持,支持的语言重要包含2种：中文(zh-CN)、英文(en-US)。默认是中文
①通过下拉框选择
通过访问doc.html打开文档界面,可以在文档的右上角看到语言的选择,如下图：

② 通过文档地点也可以选择
别的,如果你是使用了knife4j提供的增强功能,你也可以这样访问
③ 通过application.yml设置文件设置
  1. knife4j:
  2.   enable: true
  3.   setting:
  4.     language: zh_cn
复制代码
6.4 接口添加作者

接口代码如下,我们给hello接口添加作者“张三”
  1. @ApiOperationSupport(author = "张三")
  2. @GetMapping("/hello")
  3. public String hello(){
  4.     return "hello";
  5. }
复制代码

6.5 自界说文档

偶然候在OpenAPI不敷以满意接口阐明的情况下,我们可以通过.md格式文件扩充体系文档阐明
①添加自界说文档
我们可以在当前项目中添加多个文件夹，文件夹中存放.md格式的markdown文件,每个.md文档代表一份自界说文档阐明。
这里，我们在默认组default 下面添加接口署名认证文档阐明.md和自界说文档阐明.md 两个文档，结构如下

每个.md文件中，Knife4j允许一级(h1)、二级(h2)、三级(h3)标题作为最终的文档标题
比如，上面添加的自界说文档阐明.md内容如下
  1. # 自定义文档说明
  3. ## 效果说明
  5. `knife4j`为了满足文档的个性化配置,添加了自定义文档功能
  7. 开发者可自定义`md`文件扩展补充整个系统的文档说明
  9. 开发者可以在当前项目中添加一个文件夹，文件夹中存放`.md`格式的markdown文件,每个`.md`文档代表一份自定义文档说明
  11. **注意**：自定义文档说明必须以`.md`结尾的文件,其他格式文件会被忽略
复制代码
② 设置自界说文档显示
文档添加好之后，我们在application.yml 添加如下设置信息
  1. knife4j:
  2.   documents:
  3.     - group: default
  4.       name: 其他文档
  5.       # 某一个文件夹下所有的.md文件
  6.       locations: classpath:markdown/*
复制代码
设置阐明：
③ 前端界面呈现效果
上述信息设置好之后，在浏览器访问doc.html 如下

6.6 访问权限控制

为了保证生产情况下接口服务安全，我们可以提供一个登岸界面的功能,只有输入用户名和密码才气访问
① 在application.yml 中添加如下设置
  1. knife4j:
  2.   enable: true
  3.   basic:
  4.     enable: true
  5.     username: xiezhr
  6.     password: 123456
复制代码
②需要输入正确的用户名和密码才气访问

6.7 接口排序

使用Knife4j提供的增强注解@ApiOperationSupport中的order字段可进行接口排序
HelloController 中有hello 和 getToken 两个接口，我们要实现getToken接口显示在前面，代码如下
① 修改application.yml
  1. springdoc:
  2.   swagger-ui:
  3.     operations-sorter: order
复制代码
② 调整@ApiOperationSupport中的order
  1. @RestController
  2. public class HelloController {
  3.     @ApiOperationSupport(author = "张三",order = 2)
  4.     @GetMapping("/hello")
  5.     public String hello(){
  6.         return "hello";
  7.     }
  9.     @ApiOperationSupport(author = "李四" ,order = 1)
  10.     @GetMapping("/access-appid")
  11.     public String getToken(){
  13.         return "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
  14.     }
  15. }
复制代码
③ 接口显示顺序如下

6.8 接口分组

为了演示API分组，我们在controller包下面再创建admin包和common包，包下分别添加AdminController和CommonController接口类,结构及代码如下

① AdminController类
  1. @RequestMapping("admin")
  2. @RestController
  3. public class AdminController {
  5.     @GetMapping("/access-appid")
  6.     public String getToken(){
  8.         return "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
  9.     }
  10. }
复制代码
② CommonController 类
  1. @RequestMapping("common")
  2. @RestController
  3. public class CommonController {
  5.     @GetMapping("/hello")
  6.     public String hello(){
  7.         return "hello";
  8.     }
  10.     @GetMapping("/hi")
  11.     public String Hi(){
  12.         return "Hi 程序员晓凡";
  13.     }
  14. }
复制代码
在默认情况（没有分组）的情况下，全部包下接口都显示在一一个默认组下面，如/common/*  和/admin/* 访问路径下的接口都显示在一起，如下图所示

这时，如果/common/* 下的接口比较多，/admin/* 下的接口也比较多，界面上显示就很混乱
解决办法就是添加分组信息，这里有两种设置方法
① 通过application.yml设置 admin分组和common 两个分组
  1. springdoc:
  2.   group-configs:
  3.     - group: 'admin'
  4.       paths-to-match: '/admin/**'
  5.       packages-to-scan: com.xiezhr.knife4jspringboot3demo.controller
  6.     - group: 'common'
  7.       paths-to-match: '/common/**'
  8.       packages-to-scan: com.xiezhr.knife4jspringboot3demo.controller
复制代码
② 通过设置类Knife4jConfig添加两个分组
  1. @Configuration
  2. public class SpringDocConfig {
  3.   // 此处省去其他配置信息......
  4.    
  5.     @Bean("common")
  6.     public GroupedOpenApi webGroupApi() {
  7.         return GroupedOpenApi.builder().group("common")
  8.                 .pathsToMatch("/common/**")
  9.                 .build();
  10.     }
  12.     @Bean("admin")
  13.     public GroupedOpenApi adminGroupApi() {
  14.         return GroupedOpenApi.builder().group("admin")
  15.                 .pathsToMatch("/admin/**")
  16.                 .build();
  17.     }
  19. }
复制代码
以上两种设置时等效的，再访问:http://localhost:8080/doc.html 显示如下

6.9 动态哀求参数

在某些特定的情况下如果后端界说的是一种Map结构,大概是参数并没有界说声明,而希望也能达到一种动态添加参数进行调试的效果,这种体验有点类似于postman
① 开启动态参数设置
  1. knife4j:
  2.   enable: true
  3.   setting:
  4.   # 开启动态请求参数，true-开启，false-关闭
  5.     enable-dynamic-parameter: true
复制代码
设置完后，开启动态哀求这个会勾上

② 添加动态参数调试


6.10 过滤哀求参数

通常我们在开发接口时,比如一个新增接口和一个修改接口,修改接口需要转达主键id、而新增接口则不需要转达此属性,但大部分情况,我们只写一个Model类,此时在新增接口时显示主键id会显得许多余.
使用自界说增强注解ApiOperationSupport中的ignoreParameters属性,可以强制忽略要显示的参数.
忽略的规则如下：
在接口过滤时,重要有两种情况
6.10.1 表单参数

我们在使用实体类直接作为参数时,在我们的ui界面中是不会显示参数名称的,此时可以直接使用实体的属性名称进行参数忽略，例如如下代码：
表单类型的哀求是不需要添加参数名的
  1. @ApiOperation(value = "新增Model接口1")
  2. @ApiOperationSupport(ignoreParameters = {"id","orderDate.id"})
  3. @PostMapping("/insertMode1l")
  4. public Rest<UptModel> insertModel1(UptModel uptModel){
  5.     Rest<UptModel> r =new Rest<>();
  6.     r.setData(uptModel);
  7.     return r;
  8. }
复制代码
实体类UptModel.java文件代码
  1. public class UptModel {
  3.     @ApiModelProperty(value = "主键id")
  4.     private String id;
  6.     @ApiModelProperty(value = "姓名")
  7.     private String name;
  9.     @ApiModelProperty(value = "邮箱")
  10.     private String email;
  12.     @ApiModelProperty(value = "订单信息")
  13.     private OrderDate orderDate;
  14. }
复制代码
此时，最终过过滤掉UptModel的属性id和属性orderDate类中的id属性,不在界面显示.

6.10.2 JSON参数

如果哀求参数是使用JSON的方式
代码如下：
  1. @ApiOperation(value = "新增Model接口")
  2. @ApiOperationSupport(ignoreParameters = {"uptModel.id","uptModel.name","uptModel.orderDate.id"})
  3. @PostMapping("/insertModel")
  4. public Rest<UptModel> insertModel(@RequestBody UptModel uptModel){
  5.     Rest<UptModel> r =new Rest<>();
  6.     r.setData(uptModel);
  7.     return r;
  8. }
复制代码
此时如果要过滤id的话,需要指定带上参数名称uptModel
最终忽略的值为ignoreParameters = {"uptModel.id","uptModel.name","uptModel.orderDate.id"}

6.11 包含哀求参数

时候需要忽略的参数太多时,我们需要写许多的忽略参数属性,此时,一个与忽略参数对立取反的特性就显得很有帮助了
使用自界说增强注解ApiOperationSupport中的includeParameters属性,可以强制包含要显示的参数.去除多余的参数
6.12 自界说Host

不同的网络情况,可以通过设置该属性,方便的进行调试
通过设置application.yml
  1. knife4j:
  2.   enable: true
  3.   setting:
  4.     # 是否启用Host
  5.     enable-host: true
  6.     # 启用Host后地址，例如：http://192.168.0.111:8080
  7.     enable-host-text: "http://192.168.0.111:8080"
复制代码
6.13 全局参数

Knife4j 提供全局参数设置功能，例如：我们可以设置全局token参数
全局参数功能重要提供两种参数类型：
设置方法如下

6.14 自界说主页内容

可以提供一个Markdown文件来自界说显示Home主页的显示内容，通过设置yml来进行开启，设置文件如下
  1. knife4j:
  2.   enable: true
  3.   setting:
  4.     enable-home-custom: true
  5.     home-custom-path: classpath:markdown/home.md
复制代码
我们markdown目录下添加home.md 文档，并添加内容之后，最终界面显示如下


6.15 自界说Footer

Knife4j 支持自界说界面底部Footer内容，可以更改为公司大概产品介绍等信息
未自界说前

通过设置application.yml后
  1. knife4j:
  2.   enable: true
  3.   setting:
  4.     enable-footer: true
  5.     enable-footer-custom: true
  6.     footer-custom-content: Apache License 2.0 | Copyright  2019-[程序员晓凡](https://www.xiezhrspace.cn)
复制代码

七、其他功能

7.1 导出离线文档

使用swagger的时候，导出一份精细的文档，需要很繁琐的步调，集成了knife4j之后，导出文档变得很简朴
而且还可以导出不同格式的文档

7.2 导出postman

我们还可以将接口信息复制然后导出到postman工具进行调试
具体操作如下

7.3 天生前端调用代码


八、小结

SpringBoot3 整合knife4j实在非常简朴，界面相对于swagger UI 确实雅观了不少。文章只列举了常用功能，如果小伙伴有特殊的需求，可以浏览官方文档，官方文档还是非常具体的。
作者也给出了各种场景的实战demo: https://gitee.com/xiaoym/swagger-bootstrap-ui-demo
SpringBoot各种版本的整合都有案例

本期内容到这儿就竣事了 ★,°:.☆(￣▽￣)/$:.°★ 。 希望对您有所帮助
我们下期再见 (●'◡'●) ヾ(•ω•`)o

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。



欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/) Powered by Discuz! X3.4