SpringBoot整合Swagger3

最新推荐文章于 2025-05-11 17:30:47 发布
最新推荐文章于 2025-05-11 17:30:47 发布
阅读量275 收藏 1
点赞数
分类专栏： SpringBoot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/quest101/article/details/118253703
版权

概述

​ Swagger™ 的目标是为 REST API 定义一个标准的、与语言无关的接口，它允许人们和计算机在不访问源代码、文档或通过网络流量检查的情况下发现和理解服务的功能。当通过 Swagger 正确定义，用户可以使用最少的实现逻辑理解远程服务并与之交互。

Swagger注解

swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。

  • @Api：修饰整个类，描述Controller的作用
  • @ApiOperation：描述一个类的一个方法，或者说一个接口
  • @ApiParam：单个参数描述
  • @ApiModel：用对象来接收参数
  • @ApiProperty：用对象接收参数时，描述对象的一个字段
  • @ApiResponse：HTTP响应其中1个描述
  • @ApiResponses：HTTP响应整体描述
  • @ApiIgnore：使用该注解忽略这个API
  • @ApiError ：发生错误返回的信息
  • @ApiImplicitParam：一个请求参数
  • @ApiImplicitParams：多个请求参数

整合Swagger3

添加 Maven 依赖

<!-- springfox -->
  <dependency>
    <groupId>io.springfox</groupId
最低0.47元/天 解锁文章
【Springboot系列】Springboot整合Swagger3不简单
我是香菜
04-23 6294
例子中简单的使用了swagger，学会了几个知识点@ApiModel 标注对象，会把整个对象做解析@ApiModelProperty 标注字段，会显示字段的意义@Api(tags = "第三方接口") 标注接口的组，可以将接口进行归类，不局限于类@ApiOperation 标注接口，相当于接口的注释@ApiImplicitParams 对参数进行注释。
项目整合swagger
陌上人如玉，公子世无双
05-25 453
项目整合swagger
Springboot整合Swagger3
最新发布
Java后端技术栈
05-11 170
Springboot 配置使用Swagger3
热门推荐
泡泡的博客
03-12 2万+
Swagger是一个可以根据你的代码，自动生成接口文档的一个工具，并且可以用作接口测试工具，2022年了，Swagger也要用3.0版本了吧启动项目，访问，注意 Swagger3 和 2 访问的页面有细微差别。
SpringBoot3使用Swagger3
Q95470的博客
06-17 4283
Swagger是一个用于设计、构建、文档化和使用RESTful Web服务的开源工具。Swagger3是Swagger的最新版本，它提供了许多新功能和改进。Swagger在SpringBoot3中的引入方法发生了改变,网上大部分还是SpringBoot2的版本。访问http://localhost:9090/swagger-ui/index.html#/其中的9090 改成你项目后端使用的端口，注意不能省略后面的index.html。版本也可以使用新版，Springdoc-OpenAPI。
Java实战：Spring Boot集成Swagger3
oandy0的博客
02-23 7214
本文将详细介绍如何在Spring Boot应用程序中集成Swagger3，以构建现代化的RESTful API文档
SpringBoot整合Swagger3生成接口文档过程解析
08-18
SpringBoot整合Swagger3生成接口文档过程解析 SpringBoot整合Swagger3生成接口文档过程解析是当前项目中非常重要的一部分，在前后端分离的项目中，接口文档的存在十分重要。 Swagger是一个自动生成接口文档的工具...
SpringBoot整合Swagger3环境搭建
m0_64245578的博客
10-21 1461
【代码】SpringBoot整合Swagger3环境搭建。
springBoot整合Swagger项目例子
01-22
SpringBoot整合Swagger项目是一个实用的例子，它展示了如何在SpringBoot应用程序中集成Swagger，以便于创建API文档和进行接口测试。Swagger是一个强大的工具，用于设计、构建、文档化和使用RESTful Web服务。在这个...
springboot整合swagger3
吉屋安的博客
06-07 3155
注解表示该方法返回一个 Spring Bean，用于配置 Swagger 的 Docket 对象。类定义了 Swagger 的基本配置和 API 文档信息，使得你可以生成并展示美观的接口文档界面。是 Swagger 的主要配置类，它提供了一系列的配置选项。对象，用于配置接口的认证方式。在这里，我们使用 API Key 的方式进行认证，并通过。对象，用于设置 API 文档的基本信息，包括标题、描述、版本和联系人等。这是一个配置类的声明，使用了。注解，表示这是一个配置类。用于定义认证头的名称，
SpringBoot-Swagger3
qq_44989062的博客
09-02 2047
swagger
SpringBoot配置Swagger3
八戒的博客
06-21 583
启动程序，在浏览器中输入地址：http://localhost:8083/swagger-ui/index.html#/@ApiModelProperty(value = “字段描述”)@Parameter(description = “参数描述”)@Operation(summary = “接口方法描述”)1.在Controller中写上接口的api注解。@ApiModel(“实体类的描述”)@Api(tags=“接口描述”)controller的方法参数中。controller 方法上。
spring boot集成swagger3
chenglc1612的博客
01-12 312
spring boot集成swagger3 swagger2的整合：https://www.cnblogs.com/chenglc/p/10910721.html swagger3的使用步骤和2略有差异 maven依赖 <dependency> <groupId>io.springfox</groupId> <artifa...
9、Springboot整合Swagger3
daohangtaiqian的博客
12-03 1795
我们在编写了大量的接口之后，如果接口的调用者不是自身的话，那么就会面临要编写接口文档的苦恼，这时候Swagger就应运而生了。
SpringBoot整合Swagger3，赶紧整起来！
零度念者的博客
11-09 1496
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码，允许 API 来始终保持同步。Swagger 让部署管理和使用，功通过集成 Swagger3，我们可以方便地生成接口文档，使得前后端开发协同更加高效，通过knife4j进行美化后的页面更加适合国人的阅读习惯。以上就是SpringBoot整合Swagger3的方式，是不是很简单，赶紧用起来吧！！！
springboot 整合swagger3
02-06
### Spring Boot 整合 Swagger3 示例 #### 添加 Maven 依赖 为了在 Spring Boot 项目中集成 Swagger3，需更新 `pom.xml` 文件以引入必要的依赖项。对于 Swagger3 的支持通常通过 OpenAPI 3.x 版本来实现： ```xml <dependencies> <!-- 其他已有依赖 --> <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-ui</artifactId> <version>1.7.0</version> </dependency> <!-- 如果需要额外的功能可以考虑加入下面的依赖 --> <!--<dependency>--> <!--<groupId>org.springdoc</groupId>--> <!--<artifactId>springdoc-openapi-data-rest</artifactId>--> <!--<version>1.7.0</version>--> <!--</dependency>--> <!-- 更多可选模块可以根据实际需求添加 --> </dependencies> ``` 此部分操作确保了应用程序能够利用最新的 OpenAPI 规范特性[^4]。 #### 创建配置类 接着，在项目的配置文件夹下创建一个新的 Java 配置类用于激活并自定义 Swagger 功能。注意这里不再使用旧版本中的 `@EnableSwagger2` 注解而是采用更现代的方式来进行设置： ```java import org.springframework.context.annotation.Configuration; // 导入其他所需包... @Configuration(proxyBeanMethods = false) public class SwaggerConfig { } ``` 由于采用了 springdoc-openapi 库，默认情况下已经自动集成了大部分常用功能，因此大多数场景无需编写复杂的配置逻辑即可正常工作[^2]。 #### 启动服务与访问接口文档页面 完成上述两步之后重新构建并运行 Spring Boot 应用程序。此时应该能够在浏览器里打开如下链接查看 API 文档界面： - **http://localhost:8080/swagger-ui/** 或者 **http://localhost:8080/doc.html** 这两个 URL 提供了不同风格但同样强大的交互式 API 测试环境给开发者使用[^3]。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值