当前位置：首页 > article >正文

Springboot集成Swagger和Springdoc详解

article 2025/1/27 13:52:16

Springboot2.x集成Swagger2
- 1. Springboot匹配版本2.7.0~2.7.18（其它版本需要自己去调试匹配）
- 2. 首先导入Swagger2匹配的依赖项
- 3. 导入依赖后创建配置文件SwaggerConfig
- 4. Swagger集成完后，接下来接口的配置
Springboot3.x集成Springdoc
- 1. Springboot3.x依赖Springdoc配置
- 2. 在工程config目录下创建配置文件SpringdocConfig（API文档的基础配置信息，实际开发中修改成你自己的项目配置信息）
- 3. 依赖集成已经完成了，下面针对接口的相关配置
Swagger2、Springdoc测试

Swagger2可以让开发者更方便地构建 API 文档和测试，目前最新的Swagger2只支持到3.0.0已经不在维护了，相对应Springboot版本为2.x。针对Springboot2.7.0~2.7.18可以集成swagger2:2.9.2稳定版本，Springboot3.x社区推荐使用 Springdoc OpenAPI 作为其替代品，Springdoc OpenAPI 是 Springfox 的官方继承者，提供了更新的特性和更好的维护。下面将以Springboot2.x和3.x分别介绍集成Swagger2和Springdoc的使用详解。
在这里插入图片描述
官方文档：
【Swagger2支持Springboot3.0及以下】https://swagger.io/docs/
【Springdoc支持Springboot3.0及以上】https://springdoc.org/

Springboot2.x集成Swagger2

1. Springboot匹配版本2.7.0~2.7.18（其它版本需要自己去调试匹配）

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.7.18</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

<properties>
    <java.version>17</java.version>
    <spring.boot.version>2.7.18</spring.boot.version>
    <org.lombok.version>1.18.34</org.lombok.version>
</properties>

<dependency>
    <groupId>org.springframework.boot</groupId