SpringBoot后端开发常用工具详细介绍——SpringDoc接口文档

背景说明

之前springboot开发的时候,每次都用一个框架,Java8和springboot2用了好久,一直都是用Swagger2生成接口文档。

前段时间换了Java17和springboot3,发现springfox+swagger2报错了,觉得是版本问题,就去maven仓库中找最新的swagger2的依赖版本,结果发现这东西好久没更新了,自然用在最新的技术里就不支持了。

找了好久发现Java17和springboot3已经不再支持springfox和swagger了,于是更换了springdoc生成swagger接口文档。

Swagger接口文档

官方文档

可以参考的内容springdoc使用方法

依赖

xml 复制代码
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>${spring-doc.version}</version>
</dependency>
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
    <version>${spring-doc.version}</version>
</dependency>

访问地址

纯json地址http://localhost:10220/v3/api-docs

有ui的地址http://localhost:10220/swagger-ui/index.html

配置文件

yml 复制代码
springdoc:
  packages-to-scan: com.swaggerdemo.test.controller #扫描的接口类的包
  api-docs:
  	enabled: true # 是否启用
    path: /v3/api-docs  #配置纯json地址
  swagger-ui:
    path: /swagger-ui.html #配置swagger ui的地址

配置类

分组

java 复制代码
@Configuration
public class SwaggerConfig {
    @Bean
    public OpenAPI openAPI() {
        return new OpenAPI()
                .info(this.getApiInfo());
    }

	// 分组
    @Bean("sysGroupApi")
    public GroupedOpenApi sysGroupApi() {
        return GroupedOpenApi.builder().group("系统模块组")
                .pathsToMatch("/test/**") // 以/test开始的接口,右上角的分组
                .build();
    }

    private Info getApiInfo() {
        return new Info()
                .title("标题")
                .description("描述")
                .summary("")
                .version("版本");
    }
}
相关推荐
文丑颜不良啊25 分钟前
LeetCode3281~3300题目解析
java·leetcode
用户460438522508634 分钟前
关于 Paimon-Rust 的写操作(细节)
后端
掘金酱43 分钟前
AI 带来的新生意|稀土掘金 X-Lab 年度大会招募开启
前端·后端·vibecoding
nice_lcj5201 小时前
【从零理解计算机网络 · 02】分层模型:别背 OSI 七层,看数据怎么被“打包“和“拆包“
java·后端·tcp/ip·计算机网络·面试·osi·分层模型
SimonKing2 小时前
给Deepseek Harness装上插件市场,从此插件无忧
java·后端·程序员
艾莉丝努力练剑2 小时前
【AI大模型接入SDK】C++的SessionManager 线程安全
java·开发语言·前端·c++·人工智能·学习·安全
aiotto资源分享3 小时前
Python 写 JSON 文件,程序中途退出会留下什么?
java·python·json·jsondecodeerror
利威尔xu3 小时前
Go Mutex 饥饿模式:正常模式等待者饿死,1ms 阈值自动切换崩溃
开发语言·后端·面试·golang·并发编程
一条Go3 小时前
边缘 Agent:为什么是它连出来,而不是平台连进去
后端·架构·github
RuoyiOffice4 小时前
SpringBoot3+Vue3 采购到付款:ERP、WMS与财务如何按同一来源协同
java·spring boot·架构·vue