快捷導(dǎo)航

springBoo3.0集成knife4j4.1.0的詳細(xì)教程(swagger3)

更新時(shí)間：2023年07月20日 11:18:56 作者：華義辰

這篇文章主要介紹了springBoo3.0集成knife4j4.1.0的詳細(xì)教程(swagger3),本文給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

溫馨提示：

springBoot 版本 3.0+

knife4j 版本 4.1.0

添加依賴：knife4j包含了swagger，openapi3中的依賴，所以加這一個(gè)就行。

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
    <version>4.1.0</version>
</dependency>
<!--springBoot相關(guān)配置忽略-->

yml文件中配置：

#springdoc相關(guān)配置
springdoc:
  swagger-ui:
    path: /swagger-ui.html
    tags-sorter: alpha
    operations-sorter: alpha
  api-docs:
    path: /v3/api-docs
  group-configs:
    - group: 'hyc'
      paths-to-match: '/**'
      packages-to-scan: com.hyc  #改成你自己的包名，一般到啟動(dòng)類的包名
#knife4j相關(guān)配置 可以不用改
knife4j:
  enable: true
  setting:
    language: zh_cn
    swagger-model-name: 實(shí)體類

然后，就可以啟動(dòng)測(cè)試輸入地址http://ip:port/doc.html

注解的基本使用可以看下這里：swagger3注解和swagger2的區(qū)別

這里主要提下請(qǐng)求參數(shù)為文件的時(shí)候怎么寫

@Parameter(name = "image", description = "圖片文件", required = true,schema =@Schema(type = "file"))

在@Parameter參數(shù)注解里面加
schema = @Schema(type = "string", format = "binary")

注意：如果實(shí)體類沒有在頁面顯示如下：

這是因?yàn)槟氵@個(gè)實(shí)體類沒有在controller層使用，沒有使用，就不會(huì)在這顯示的。

到此這篇關(guān)于springBoo3.0集成knife4j4.1.0（swagger3）的文章就介紹到這了,更多相關(guān)springBoo3集成knife4j內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

相關(guān)文章

一文詳解Java中的finalize()方法
Java中的finalize()是Object類的一個(gè)方法,用于對(duì)象被垃圾回收前執(zhí)行清理操作,這篇文章主要介紹了Java中finalize()方法的相關(guān)資料,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下
2025-09-09
springboot如何實(shí)現(xiàn)國(guó)際化配置
這篇文章主要介紹了springboot如何實(shí)現(xiàn)國(guó)際化配置問題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教
2023-06-06
利用java判斷質(zhì)數(shù)的3種方法代碼示例
這篇文章主要給大家介紹了關(guān)于利用java判斷質(zhì)數(shù)的3種方法,在大于1的整數(shù)中,如果只包含1和本身這兩個(gè)約數(shù),就被稱為質(zhì)數(shù)(素?cái)?shù)),文中給出了詳細(xì)的代碼示例,需要的朋友可以參考下
2023-07-07
解讀@ConfigurationProperties的基本用法
這篇文章主要介紹了@ConfigurationProperties的基本用法,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
2025-03-03
Spring事務(wù)管理只對(duì)出現(xiàn)運(yùn)行期異常進(jìn)行回滾
Spring的事務(wù)管理默認(rèn)只對(duì)出現(xiàn)運(yùn)行期異常(java.lang.RuntimeException及其子類)進(jìn)行回滾,需要了解更多Spring事務(wù)方面的知識(shí)，可詳看本文
2012-11-11
如何用Jfinal連接多個(gè)數(shù)據(jù)庫(kù)
這篇文章主要介紹了如何用Jfinal連接多個(gè)數(shù)據(jù)庫(kù)，幫助大家更好的理解和學(xué)習(xí)使用Jfinal，感興趣的朋友可以了解下
2021-03-03
SpringBoot啟動(dòng)后啟動(dòng)內(nèi)嵌瀏覽器的方法
這篇文章主要介紹了SpringBoot啟動(dòng)后啟動(dòng)內(nèi)嵌瀏覽器的方法，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
2019-12-12
Spring中的編程式事務(wù)和聲明式事務(wù)
Spring框架中,事務(wù)管理可以通過編程式事務(wù)和聲明式事務(wù)兩種方式實(shí)現(xiàn),編程式事務(wù)通過手動(dòng)編碼控制事務(wù)的開始、提交和回滾,允許開發(fā)者精確控制事務(wù),但增加了代碼復(fù)雜度,聲明式事務(wù)則通過@EnableTransactionManagement注解啟用事務(wù)管理
2024-11-11
辨析Java中的String與StringBuffer及StringBuilder字符串類
這里將為大家來辨析Java中的String與StringBuffer及StringBuilder字符串類型,通常來說StringBuilder的性能更加,需要的朋友可以參考下
2016-05-05
淺談@PostConstruct不被調(diào)用的原因
這篇文章主要介紹了淺談@PostConstruct不被調(diào)用的原因及分析，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教
2022-02-02