SpringDoc如何集成到Springboot

更新時(shí)間：2025年06月21日 10:32:00 作者：MartinYangHJ

本文介紹了SpringDoc集成Spring Boot的步驟,包括Maven引入依賴、創(chuàng)建OpenApiConfig文件、配置application.yml及移除SpringFox依賴,以實(shí)現(xiàn)OpenAPI文檔功能,感興趣的朋友一起看看吧

1.Maven引入jar包

           <dependency>
                <groupId>org.springdoc</groupId>
                <artifactId>springdoc-openapi-ui</artifactId>
                <version>1.6.14</version> 
            </dependency>

2.新建OpenApiConfig文件，代碼如下

package com.elane.project.ztt.config;
import io.swagger.v3.oas.annotations.enums.SecuritySchemeIn;
import io.swagger.v3.oas.annotations.enums.SecuritySchemeType;
import io.swagger.v3.oas.annotations.security.SecurityScheme;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.security.SecurityRequirement;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
//swagger顯示Authorization
//@SecurityScheme(
//        name = "bearerAuth",  // 安全方案的唯一名稱
//        type = SecuritySchemeType.HTTP,
//        scheme = "bearer",
//        bearerFormat = "JWT"  // 可選，表明 Token 格式為 JWT
//)
//將未登錄header中的Authorization替換為sid
@SecurityScheme(
        name = "sid",
        type = SecuritySchemeType.APIKEY,
        in = SecuritySchemeIn.HEADER,
        paramName = "sid"
)
@Configuration
public class OpenApiConfig {
    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                .info(new Info()
                        .title("API文檔")
                        .version("1.0")
                        .description("API文檔描述"))
                .addSecurityItem(new SecurityRequirement().addList("sid"));
    }
}

3.application.yml文件增加如下配置

springdoc:
  api-docs:
    path: /v3/api-docs # 更改 API 文檔路徑
  swagger-ui:
    path: /swagger-ui.html # 更改 Swagger UI 路徑
    disable-swagger-default-url: true # 禁用默認(rèn) URL 加載
    operations-sort-parameter: alpha # 按字母順序排序 API

4.注意

如果在項(xiàng)目中使用過SpringFox，需要將SpringFox的依賴全部移除

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

您可能感興趣的文章:

相關(guān)文章

mybatis調(diào)用存儲(chǔ)過程的實(shí)例代碼
這篇文章主要介紹了mybatis調(diào)用存儲(chǔ)過程的實(shí)例，非常不錯(cuò)，具有參考借鑒價(jià)值,需要的朋友可以參考下
2017-10-10
Java中常用的代碼匯總
本文給大家分享了20個(gè)常用的java代碼，都是別人項(xiàng)目中使用過的代碼，這里推薦給大家，有需要的小伙伴可以參考下。
2015-05-05
類似Object監(jiān)視器方法的Condition接口(詳解)
下面小編就為大家?guī)硪黄愃芆bject監(jiān)視器方法的Condition接口(詳解)。小編覺得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧
2017-05-05
徹底理解Java中this 關(guān)鍵字
這篇文章主要介紹了徹底理解Java中this 關(guān)鍵字的相關(guān)資料,非常不錯(cuò)，具有參考價(jià)值，需要的朋友可以參考下
2016-05-05
Idea2019創(chuàng)建Springboot Web項(xiàng)目的方法步驟
這篇文章主要介紹了Idea2019創(chuàng)建Springboot Web項(xiàng)目的方法步驟，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
2019-10-10
JAVA實(shí)現(xiàn)異步調(diào)用實(shí)例代碼
在java平臺(tái)，實(shí)現(xiàn)異步調(diào)用的角色主要三種角色：調(diào)用者、取貨憑證、真實(shí)數(shù)據(jù)。本篇文章給大家介紹java實(shí)現(xiàn)異步調(diào)用實(shí)例代碼，需要的朋友可以參考下
2015-09-09
Java如何連接數(shù)據(jù)庫圖文教程
關(guān)于java數(shù)據(jù)庫的文章早已是非常多了,本文是對(duì)我個(gè)人過往學(xué)習(xí)java數(shù)據(jù)庫,理解及應(yīng)用java數(shù)據(jù)庫的一個(gè)總結(jié),下面這篇文章主要給大家介紹了關(guān)于Java如何連接數(shù)據(jù)庫的相關(guān)資料,需要的朋友可以參考下
2023-04-04
JVM致命錯(cuò)誤日志詳解(最新推薦)
這篇文章主要介紹了JVM致命錯(cuò)誤日志詳解,本文通過實(shí)例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下
2023-06-06
JSON.parseObject和JSON.toJSONString實(shí)例詳解
這篇文章主要為大家詳細(xì)介紹了JSON.parseObject和JSON.toJSONString實(shí)例，具有一定的參考價(jià)值，感興趣的朋友可以參考一下
2018-06-06
Java Elastic Job動(dòng)態(tài)添加任務(wù)實(shí)現(xiàn)過程解析
這篇文章主要介紹了Java Elastic Job動(dòng)態(tài)添加任務(wù)實(shí)現(xiàn)過程解析,文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
2020-08-08