Knife4j 4.0版本正式發(fā)布了！

該版本處理了近12個(gè)月以來(lái)Gitee、GitHub兩大平臺(tái)積壓的近300多個(gè)issue

同時(shí)也帶來(lái)了一些新的特性。

主要更新亮點(diǎn)：

• 統(tǒng)一各個(gè)組件版本號(hào),使用Knife4j時(shí)開(kāi)發(fā)者根據(jù)需要自行引用,artifactId發(fā)生了變化
• 支持Spring Boot 3
• 兼容適配springdoc-openapi底層框架，全面遷移到OpenAPI3的規(guī)范支持
• 針對(duì)OpenAPI2(Swagger)規(guī)范提供了優(yōu)化，開(kāi)發(fā)者基于Spring Boot2版本可以無(wú)縫銜接
• Knife4j-Desktop組件架構(gòu)升級(jí)重寫(xiě)，新架構(gòu)支持不同需求的OpenAPI規(guī)范進(jìn)行聚合
• 提供官方Docker鏡像服務(wù)，基于Knife4j可方便在云服務(wù)上進(jìn)行使用
• 官網(wǎng)文檔更新重寫(xiě)

架構(gòu)整理

為了以后Knife4j發(fā)展的可持續(xù)性，整個(gè)架構(gòu)重新梳理，后續(xù)可以根據(jù)不同的需求，提供不同的服務(wù)

新的架構(gòu)圖，有的是規(guī)劃(尚未實(shí)現(xiàn))，有的已經(jīng)實(shí)現(xiàn)，歡迎大佬一起貢獻(xiàn)。

統(tǒng)一版本

在此次4.0版本中，統(tǒng)一各個(gè)版本，將OpenAPI2規(guī)范與OpenAPI3規(guī)范區(qū)分開(kāi)，避免版本及規(guī)范混亂使用產(chǎn)生的誤解，使用者可以更清晰

需要注意，4.0版本artifactId發(fā)生了變化

目前knife4j的項(xiàng)目結(jié)構(gòu)：

開(kāi)發(fā)者繼續(xù)使用Spring Boot 2以及OpenAPI2的規(guī)范

該starter底層依然依賴springfox項(xiàng)目，版本2.10.5

可以使用knife4j-openapi2-spring-boot-starter,maven坐標(biāo)如下：

<dependency>
<groupId>com.github.xiaoymingroupId>
<artifactId>knife4j-openapi2-spring-boot-starterartifactId>
<version>4.0.0version>
dependency>

開(kāi)發(fā)者使用Spring Boot 2以及OpenAPI3規(guī)范，那需要考慮在項(xiàng)目的注解上做遷移變更，并且knife4j 4.0版本針對(duì)3的規(guī)范底層遷移使用springdoc-openapi項(xiàng)目，放棄springfox3.0

可以使用knife4j-openapi3-spring-boot-starter,maven坐標(biāo)如下：

<dependency>
<groupId>com.github.xiaoymingroupId>
<artifactId>knife4j-openapi3-spring-boot-starterartifactId>
<version>4.0.0version>
dependency>

支持Spring Boot 3

開(kāi)發(fā)者使用Spring Boot 3以及使用OpenAPI3規(guī)范

可以使用knife4j-openapi3-jakarta-spring-boot-starter,maven坐標(biāo)如下：

<dependency>
<groupId>com.github.xiaoymingroupId>
<artifactId>knife4j-openapi3-jakarta-spring-boot-starterartifactId>
<version>4.0.0version>
dependency>

Knife4j配置屬性變化

此次Knife4j提供的Spring Boot Starter組件，增強(qiáng)配置屬性通過(guò)spring-boot-configuration-processor工具自動(dòng)生成spring-configuration-metadata.json描述性文件，因此，不同于之前的版本，配置屬性會(huì)將之前的命名大寫(xiě)全部轉(zhuǎn)為下劃線

Knife4j之前的增強(qiáng)配置屬性(老的)：

knife4j:
enable:true
#以setting配置為例
setting:
language:zh-CN
enableSwaggerModels:true
enableDocumentManage:true

Knife4j 4.0配置的增強(qiáng)屬性(新的):

knife4j:
enable:true
setting:
custom-code:500
enable-footer-custom:false
footer-custom-content:我是自定義的Footer

springdoc-openapi項(xiàng)目增強(qiáng)適配

Knife4j之前的版本一直都是基于springfox項(xiàng)目提供了增強(qiáng)功能，此次4.0版本針對(duì)springdoc-openapi項(xiàng)目也提供了增強(qiáng)，Knife4j提供的增強(qiáng)功能可以無(wú)縫在OpenAPI3的規(guī)范中使用

Knife4j獨(dú)立服務(wù)工具架構(gòu)升級(jí)

Knife4j在此次版本中針對(duì)聚合OpenAPI規(guī)范文檔提供了獨(dú)立的服務(wù)組件

整個(gè)架構(gòu)重新設(shè)計(jì)，代碼重寫(xiě)，并將該服務(wù)發(fā)布到Docker官方鏡像倉(cāng)庫(kù)，支持不同配置中心中間件對(duì)接，數(shù)據(jù)+應(yīng)用進(jìn)行分離，OpenAPI的數(shù)據(jù)源可以輕松放到配置中心中，實(shí)現(xiàn)文檔的聚合

架構(gòu)圖如下：

文檔

Knife4j新版本文檔采用新的模板，可以區(qū)分不同的版本，方便開(kāi)發(fā)使用者PR貢獻(xiàn)或者查看

4.0版本的文檔作者正在瘋狂碼字中…….敬請(qǐng)期待.

示例程序

正是由于4.0的文檔還在輸出中，因此Knife4j在4.0新版本中也提供了不同版本的示例程序

示例如下：

• Spring Boot 2.x + OpenAPI2規(guī)范：knife4j-spring-boot27-demo
• Spring Boot 2.x +OpenAPI3規(guī)范：knife4j-springdoc-openapi-demo
• Spring Boot 3+ OpenAPI3規(guī)范：knife4j-spring-boot3-demo

整個(gè)4.0版本從確定開(kāi)發(fā)方向以及迭代過(guò)程，感興趣的朋友可以通過(guò)該issue了解：

https://gitee.com/xiaoym/knife4j/issues/I5LIQZ