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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • springboot读取yml文件中的list列表、数组、map集合和对象方法实例

    springboot读取yml文件中的list列表、数组、map集合和对象方法实例

    在平时的yml配置文件中,我们经常使用到配置基本数据类型的字符串,下面这篇文章主要给大家介绍了关于springboot读取yml文件中的list列表、数组、map集合和对象的相关资料,需要的朋友可以参考下
    2023-02-02
  • 浅谈java中Math.random()与java.util.random()的区别

    浅谈java中Math.random()与java.util.random()的区别

    下面小编就为大家带来一篇浅谈java中Math.random()与java.util.random()的区别。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-09-09
  • 浅谈java常量池

    浅谈java常量池

    下面小编就为大家带来一篇浅谈java常量池。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-06-06
  • 一篇文章让你彻底学会Java之exists()方法

    一篇文章让你彻底学会Java之exists()方法

    Java中File.exists()方法用于检查文件或目录是否存在,是文件操作的前置检查工具,这篇文章主要介绍了Java之exists()方法的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2025-07-07
  • 在Java8中构建Stream流的多种方式详解

    在Java8中构建Stream流的多种方式详解

    当我们处理集合数据时,往往需要对其进行各种操作,如过滤、映射、排序、归约等,在 Java 8 中引入的 Stream 流为我们提供了一种更加简洁和灵活的方式来处理数据,本文将介绍如何基于 Stream 构建流,为你展示创建和操作流的多种方法
    2023-08-08
  • 使用MyBatis-Plus实现联表查询分页的示例代码

    使用MyBatis-Plus实现联表查询分页的示例代码

    本文主要讲述了如何在SpringBoot项目中使用MyBatis-Plus的分页插件,通过这个示例,可以学会如何利用MyBatis-Plus进行高效的分页查询,感兴趣的可以了解一下
    2024-10-10
  • SpringBoot YAML 配置读取机制 + 数据库自动初始化原理解析

    SpringBoot YAML 配置读取机制 + 数据库自动初始化原理解析

    本文介绍了SpringBoot中YAML配置的读取流程,包括配置文件加载、配置绑定和容器管理,还详细讲解了数据库自动初始化原理,感兴趣的朋友跟随小编一起看看吧
    2025-05-05
  • Mybatis-Plus支持GBase8s分页查询的实现示例

    Mybatis-Plus支持GBase8s分页查询的实现示例

    本文主要介绍了使 Mybatis-Plus 支持 GBase8s 的分页查询,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-01-01
  • SpringMVC的注解@RequestMapping属性及使用

    SpringMVC的注解@RequestMapping属性及使用

    这篇文章主要为大家介绍了SpringMVC注解@RequestMapping属性及使用,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-05-05
  • 详解配置spring-boot-actuator时候遇到的一些小问题

    详解配置spring-boot-actuator时候遇到的一些小问题

    这篇文章主要介绍了详解配置spring-boot-actuator时候遇到的一些小问题,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-11-11

最新评论