SpringDoc如何集成到Springboot

 更新时间:2025年06月21日 10:32:00   作者:MartinYangHJ  
本文介绍了SpringDoc集成Spring Boot的步骤,包括Maven引入依赖、创建OpenApiConfig文件、配置application.yml及移除SpringFox依赖,以实现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 # 禁用默认 URL 加载
    operations-sort-parameter: alpha # 按字母顺序排序 API

4.注意 

如果在项目中使用过SpringFox,需要将SpringFox的依赖全部移除 

到此这篇关于SpringDoc如何集成到Springboot的文章就介绍到这了,更多相关SpringDoc集成Springboot内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • mybatis调用存储过程的实例代码

    mybatis调用存储过程的实例代码

    这篇文章主要介绍了mybatis调用存储过程的实例,非常不错,具有参考借鉴价值,需要的朋友可以参考下
    2017-10-10
  • Java中常用的代码汇总

    Java中常用的代码汇总

    本文给大家分享了20个常用的java代码,都是别人项目中使用过的代码,这里推荐给大家,有需要的小伙伴可以参考下。
    2015-05-05
  • 类似Object监视器方法的Condition接口(详解)

    类似Object监视器方法的Condition接口(详解)

    下面小编就为大家带来一篇类似Object监视器方法的Condition接口(详解)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-05-05
  • 彻底理解Java中this 关键字

    彻底理解Java中this 关键字

    这篇文章主要介绍了彻底理解Java中this 关键字的相关资料,非常不错,具有参考价值,需要的朋友可以参考下
    2016-05-05
  • Idea2019创建Springboot Web项目的方法步骤

    Idea2019创建Springboot Web项目的方法步骤

    这篇文章主要介绍了Idea2019创建Springboot Web项目的方法步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-10-10
  • JAVA实现异步调用实例代码

    JAVA实现异步调用实例代码

    在java平台,实现异步调用的角色主要三种角色:调用者、取货凭证、真实数据。本篇文章给大家介绍java实现异步调用实例代码,需要的朋友可以参考下
    2015-09-09
  • Java如何连接数据库图文教程

    Java如何连接数据库图文教程

    关于java数据库的文章早已是非常多了,本文是对我个人过往学习java数据库,理解及应用java数据库的一个总结,下面这篇文章主要给大家介绍了关于Java如何连接数据库的相关资料,需要的朋友可以参考下
    2023-04-04
  • JVM致命错误日志详解(最新推荐)

    JVM致命错误日志详解(最新推荐)

    这篇文章主要介绍了JVM致命错误日志详解,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-06-06
  • JSON.parseObject和JSON.toJSONString实例详解

    JSON.parseObject和JSON.toJSONString实例详解

    这篇文章主要为大家详细介绍了JSON.parseObject和JSON.toJSONString实例,具有一定的参考价值,感兴趣的朋友可以参考一下
    2018-06-06
  • Java Elastic Job动态添加任务实现过程解析

    Java Elastic Job动态添加任务实现过程解析

    这篇文章主要介绍了Java Elastic Job动态添加任务实现过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-08-08

最新评论