【web】Springboot3 集成 Swagger3

最新推荐文章于 2025-03-24 15:15:58 发布

灯笼只能来教室体验生活

最新推荐文章于 2025-03-24 15:15:58 发布

阅读量731

点赞数 9

分类专栏： web 文章标签： spring boot

本文链接：https://blog.youkuaiyun.com/m0_52733659/article/details/135427014

版权

本文介绍了如何在SpringBoot项目中使用Maven引入SpringDocSwagger3依赖，并配置SwaggerUI界面，以及如何为API添加标签和描述。通过实例展示了如何在控制器方法上应用@Tag和@Operation注解来展示API文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

文章目录

Maven 依赖
配置类（可选）
访问
示例

Maven 依赖

<!--swagger3-->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.0.2</version>
</dependency>

配置类（可选）

创建位置是任意的，我创建在 src/main/java/com/example/d

最低0.47元/天解锁文章

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

灯笼只能来教室体验生活

关注关注

9
点赞
踩
9

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

专栏目录

【SpringBoot笔记11】SpringBoot框架集成Swagger2文档

✅ Java 开发工程师，从事 Web 应用程序的研发，擅长 Spring、SpringBoot 等技术。 ✅ 热爱编程，业余时间学习新知识，通过优快云记录学习心得和笔记内容。

10-24

1239

Swagger是一款API文档工具，SpringBoot中集成Swagger之后，通过访问swagger-ui前端界面，就可以查看当前工程里面所有对外提供的接口以及出入参之后，不仅如此，swagger还可以和postman一样，直接调用后端接口地址，这在前后端分离模式下，swagger就变得非常有用了，因为前端开发人员，只需要看swagger接口文档，就可以进行开发，而不需要我们后端开发人员自己写个接口文档。SpringBoot没有专门提供swagger的starter启动器，所以我们需要自己单独引入s

springboot集成swagger3

weixin_44021888的博客

06-11

217

springboot集成swagger3

参与评论您还未登录，请先登录后发表或查看评论

Springboot 3.0.0 整合swagger

weixin_44353972的博客

12-14

2969

swagger3.0.0

SpringBoot（三）整合Swagger3框架

你佳哥

12-28

1491

基于：【狂神说Java】SpringBoot最新教程IDEA版通俗易懂目录1 前后端分离2 swagger简介3 使用3.1 导入依赖3.2 在启动主类注解@EnableOpenApi3.3 配置Swagger3Config3.4 访问使用4 总结 1 前后端分离早些年，后端时代，前端写html、css静态页面交给后端，后端根据模板引擎改数据，跳转逻辑数据渲染，MVC模式；前后端分离：后端控制层、服务层、数据访问层；前端控制层、视图层；交互靠API接口传JSON； 2 swagger简介 Res

SpringBoot3整合Swagger

热门推荐

interest_ing_的博客

03-07

1万+

Swagger是一个用于设计、构建、记录和使用RESTful web服务的开源软件框架。Swagger 3（OpenAPI 3.0）提供了更加强大和灵活的API文档生成能力。本教程将指导您如何在Spring Boot 3项目中集成Swagger3，并使用Knife4j作为UI界面。

springboot3集成Swagger3

小魏做编程

03-08

1245

http://localhost:端口号/swagger-ui/index.html。http://localhost:端口号/swagger-ui/index.html。

spring boot3 集成swagger3

不要和代码过不去

07-20

4473

1 设置pom.xml 主要是引入nexus-maven，com.github.xiaoymin 2个，cn.hutool，org.springframework。2随意位置创建 SwaggerConfig。3修改 DemoApplication。4:给控制文件添加对应注解。

SpringBoot轻松集成Swagger

筱筱攻程师的博客

06-15

696

文章目录一、简介二、SpringBoot集成Swagger第一步：创建一个SpringBoot项目第二步：引入maven坐标第三步：写yml第四步：主启动第五步：创建SwaggerConfig配置类第六步：使用swagger注解进行标识和说明三、注解说明与测试一、简介官网：https://swagger.io/ Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集

SpringBoot-集成Swagger

2501_90249203的博客

01-14

1158

五、配置Swagger自定义扫描接口5.1 默认状态我们在这个ui界面中，可以看到扫描了两个。

Springboot3.x整合swagger3

a1712763015的博客

11-29

1630

在网上看了许多教程，发现很多都是针对Spring Boot 2 框架的，即使有针对Spring Boot 3 的，用法也不太一样,配置项经常找不到类，经过对比测试，最后我使用的是 SpringDoc OpenAPI Starter WebMvc UI. 该jar包不是swagger官方推荐的springfox包,只是前端ui一样,配置会有些许不同,并且不与swagger2配置兼容,请读者注意.yml配置 (实测不加也没有报错) @OpenAPIDefinition全局只能定义一个

SpringBoot3使用Swagger3

Q95470的博客

06-17

4176

Swagger是一个用于设计、构建、文档化和使用RESTful Web服务的开源工具。Swagger3是Swagger的最新版本，它提供了许多新功能和改进。Swagger在SpringBoot3中的引入方法发生了改变,网上大部分还是SpringBoot2的版本。访问http://localhost:9090/swagger-ui/index.html#/其中的9090 改成你项目后端使用的端口，注意不能省略后面的index.html。版本也可以使用新版，Springdoc-OpenAPI。

springboot3整合knife4j详细版，包会！（不带swagger2玩）

qq_51774011的博客

07-21

7204

springboot3在整合swagger2或者3时均不太好使，而且swagger的默认ui页面真的一言难尽，官方现在推荐使用springdoc-openapi集成接口文档，但是经过测试一些注解个性化文档时存在不好使的情况，而且ui界面依然感觉不好看。本文详细记录了knife4j集成接口文档的详细使用步骤，配置详解以及注解详解。绝对是up亲身测验过的，绝对好用！！！百度了很多内容，踩了很多坑后的整理版。

SpringBoot3 整合 Swagger3

qq_65587446的博客

03-25

506

SpringBoot3 整合 Swagger3 先导入依赖，再配置文件，即可通过http://localhost:8080/swagger-ui/index.html访问

SpringBoot 集成Swagger3

zhouzhiwengang的专栏

12-24

2476

一，什么是swagger? 1, Swagger 是一个规范和完整的文档框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务文档官方网站:https://swagger.io/ 2，使用swagger要注意的地方: 在生产环境中必须关闭swagger, 它本身只用于前后端工程师之间的沟通, 可以专门使用一台内部服务器来展示ui供访问, 即使在这上面要做好安全措施 3, 因为swagger3.0.0已发布，本...

SpringBoot整合Swagger3

IT_WEH_coder的博客

10-25

2246

本文将介绍下API可视化框架Swagger在SpringBoot框架中的整合流程，对Swagger3进行测试的一系列内容。

springboot3整合swagger

weixin_53977744的博客

04-01

453

创建swaggerConfig配置类。引入swagger依赖。在需要的位置添加注解。

springboot3集成swagger2

01-30

### Spring Boot 3 集成 Swagger2 方法为了在 Spring Boot 3 中集成 Swagger2，需增加相应的 Maven 或 Gradle 依赖项来引入 Swagger 和 Springfox 库。对于 Maven 构建工具而言，在 `pom.xml` 文件内加入如下...