快捷導(dǎo)航

springboot3整合knife4j詳細(xì)圖文教程(swagger增強(qiáng))

更新時(shí)間：2024年03月11日 09:13:31 作者：LB_bei

開(kāi)發(fā)api提供對(duì)應(yīng)的接口規(guī)范進(jìn)行聯(lián)調(diào)或并行開(kāi)發(fā),api文檔管理必不可少,常用的Knife4j基于swagger(依賴(lài)已經(jīng)compile),可以進(jìn)行管理,下面這篇文章主要給大家介紹了關(guān)于springboot3整合knife4j的相關(guān)資料,需要的朋友可以參考下

前言

springboot升級(jí)到3后之前的knife4j配置就要變了一下了

1.導(dǎo)入依賴(lài)

<dependency>
        <groupId>com.github.xiaoymin</groupId>
        <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>

        <version>4.1.0</version>
</dependency>

2.創(chuàng)建配置文件

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class Knife4jConfig {

    @Bean
    public OpenAPI springShopOpenAPI() {
        return new OpenAPI()
                // 接口文檔標(biāo)題
                .info(
                        new Info().title("接口文檔")
                        // 接口文檔簡(jiǎn)介
                        .description("Knife4j OpenApi3的接口文檔")
                        // 接口文檔版本
                        .version("v1.0")
                        // 開(kāi)發(fā)者聯(lián)系方式
                        .contact(new Contact().name("").email(""))
                );
    }
}

3.controller上注解變了

@Tag(name = "首頁(yè)")
public class HomeController {

controller方法上的注解

@Operation(summary = "獲取xxx")
public Result<xxx> getxxx(){

4.實(shí)體類(lèi)應(yīng)用的注解也變了

@Data
@Schema(name = "XXX")
public class XXXVO{

    @Id
    @Schema(description = "")
    private Integer id ;

    /** 父級(jí)id */
    @Schema(description = "父級(jí)id")
    private Integer pid ;
}

總結(jié)

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

您可能感興趣的文章:

相關(guān)文章

淺談Spring Boot日志框架實(shí)踐
這篇文章主要介紹了淺談Spring Boot日志框架實(shí)踐，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧
2018-03-03
Java正則環(huán)視和反向引用功能與用法詳解
這篇文章主要介紹了Java正則環(huán)視和反向引用功能與用法,結(jié)合實(shí)例形式較為詳細(xì)的分析了java正則環(huán)視與反向引用的相關(guān)概念與使用方法,需要的朋友可以參考下
2018-01-01
Java源碼刨析之ArrayDeque
ArrayDeque是Deque接口的一個(gè)實(shí)現(xiàn)，使用了可變數(shù)組，所以沒(méi)有容量上的限制。同時(shí),?ArrayDeque是線程不安全的，在沒(méi)有外部同步的情況下，不能再多線程環(huán)境下使用<BR>
2022-07-07
解決JDK8的ParallelStream遍歷無(wú)序的問(wèn)題
這篇文章主要介紹了解決JDK8的ParallelStream遍歷無(wú)序的問(wèn)題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教
2021-07-07
Java對(duì)象存儲(chǔ)內(nèi)存布局詳解
眾所周知，Java是一門(mén)面向?qū)ο蟮恼Z(yǔ)言，那么一個(gè)對(duì)象在內(nèi)存中都包含什么東西呢，本文主要詳細(xì)介紹了Java對(duì)象的內(nèi)存布局，訪問(wèn)定位，創(chuàng)建過(guò)程，線程安全，感興趣的小伙伴可以跟著小編一起來(lái)學(xué)習(xí)
2023-04-04
淺談解決Hibernate懶加載的4種方式
這篇文章主要介紹了淺談解決Hibernate懶加載的4種方式，具有一定借鑒價(jià)值，需要的朋友可以參考下。
2017-12-12
Java阻塞隊(duì)列必看類(lèi):BlockingQueue快速了解大體框架和實(shí)現(xiàn)思路
這篇文章主要介紹了Java阻塞隊(duì)列必看類(lèi):BlockingQueue快速了解大體框架和實(shí)現(xiàn)思路，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教
2022-10-10
Springboot整合Dubbo+Nacos實(shí)現(xiàn)RPC調(diào)用的示例代碼
隨著互聯(lián)網(wǎng)技術(shù)的飛速發(fā)展,越來(lái)越多的企業(yè)和開(kāi)發(fā)者開(kāi)始關(guān)注微服務(wù)架構(gòu),Nacos是阿里巴巴開(kāi)源的一個(gè)動(dòng)態(tài)服務(wù)發(fā)現(xiàn)、配置管理和服務(wù)管理平臺(tái),本文講解如何將Spring Boot與Dubbo和Nacos整合,實(shí)現(xiàn)RPC調(diào)用,需要的朋友可以參考下
2024-02-02
java同步開(kāi)篇入門(mén)簡(jiǎn)單介紹
java中的CountDownLatch、Semaphore、CyclicBarrier這些類(lèi)又不屬于鎖，它們和鎖又有很多共同點(diǎn)，都是為了協(xié)同多線程的執(zhí)行，都是一種同步器，所以這里就借用同步來(lái)取名字了，也就是“同步系列”的來(lái)源。下面小編來(lái)簡(jiǎn)單介紹下
2019-05-05
Java基礎(chǔ)-封裝和繼承
這篇文章主要介紹了Java面向?qū)ο缶幊蹋ǚ庋b/繼承/多態(tài)）實(shí)例解析的相關(guān)內(nèi)容，具有一定參考價(jià)值，需要的朋友可以了解下希望可以幫助到你
2021-07-07