spring boot 3.x 整合Swagger3

devtools/2024/11/7 19:24:23/

环境介绍

整合Swagger

添加依赖

<dependency><groupId>org.springdoc</groupId><artifactId>springdoc-openapi-starter-webmvc-ui</artifactId><version>2.2.0</version></dependency>

添加配置类 

java">package com.tech.cloud.config;import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;@Configuration
public class Swagger3Config {// 按模块定义 当前支付模块@Beanpublic GroupedOpenApi PayApi() {return GroupedOpenApi.builder().group("支付微服务模块").pathsToMatch("/pay/**").build();}// 举例其他模块@Beanpublic GroupedOpenApi OtherApi() {return GroupedOpenApi.builder().group("其他微服务模块").pathsToMatch("/other/**", "others").build();}// 生成文档@Beanpublic OpenAPI docsOpenApi() {return new OpenAPI().info(new Info().title("cloud_tech").description("通用架构设计").version("v1.0")).externalDocs(new ExternalDocumentation().description("整合目前微服务最新组件,基于jdk17、spring boot3.2.0").url("www.baidu.com"));}}

在项目中使用

接口中使用

  • 类上 @Tag(name = "支付服务模块", description = "支付CRUD")
  • 方法上  @Operation(summary = "新增", description = "新增支付流水方法")
java">
@RestController
@Slf4j
@Tag(name = "支付服务模块", description = "支付CRUD")
public class PaymentController {@Resourceprivate PaymentService payService;@PostMapping(value = "/pay/add")@Operation(summary = "新增", description = "新增支付流水方法")public ResultData<String> addPay(@RequestBody PaymentPO pay) {System.out.println(pay.toString());int i = payService.add(pay);return ResultData.success("成功插入记录,返回值: " + i);}@DeleteMapping(value = "/pay/del/{id}")@Operation(summary = "删除", description = "删除支付流水方法")public ResultData<Integer> deletePay(@PathVariable("id") Integer id) {int i = payService.delete(id);return ResultData.success(i);}@PutMapping(value = "/pay/update")@Operation(summary = "修改", description = "修改支付流水方法")public ResultData<String> updatePay(@RequestBody PayDTO payDTO) {PaymentPO pay = new PaymentPO();BeanUtils.copyProperties(payDTO, pay);int i = payService.update(pay);return ResultData.success("成功修改记录,返回值: " + i);}@GetMapping(value = "/pay/get/{id}")@Operation(summary = "按照ID查流水", description = "查询支付流水方法")public ResultData<PaymentPO> getPayInfo(@PathVariable("id") Integer id) {return ResultData.success( payService.getById(id));}@GetMapping(value = "/get/all")@Operation(summary = "获取所有", description = "获取所有")public ResultData getAll() {List<PaymentPO> all = payService.getAll();return ResultData.success(all);}}

实体类中使用

  • 类上和字段上@Schema(title = "主键")
java">
@Data
@Table(name = "t_pay")
@Schema(title = "支付交易表实体类")
public class PaymentPO {@Id@GeneratedValue(generator = "JDBC")@Schema(title = "主键")private Integer id;/*** 支付流水号*/@Column(name = "pay_no")@Schema(title = "支付流水号")private String payNo;/*** 订单流水号*/@Column(name = "order_no")@Schema(title = "订单流水号")private String orderNo;/*** 用户账号ID*/@Column(name = "user_id")@Schema(title = "用户账号ID")private Integer userId;/*** 交易金额*/@Schema(title = "交易金额")private BigDecimal amount;/*** 删除标志,默认0不删除,1删除*/private Byte deleted;/*** 创建时间*/@Column(name = "create_time")@Schema(title = "创建时间")@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")private Date createTime;/*** 更新时间*/@Column(name = "update_time")@Schema(title = "更新时间")@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")private Date updateTime;
}

访问Swagger

主机名:端口/swagger-ui/index.html,我这里访问http://localhost:9100/swagger-ui/index.html

 按模块展示

 

查看标注的实体类 


http://www.ppmy.cn/devtools/132098.html

相关文章

深度分析《史记 货殖列传》里面赚钱的秘决有哪些?怎么实现的?用AI挖掘历史智慧--陶朱公经商之道

Claude 让我从《史记货殖列传》中分析几个重要的赚钱秘诀&#xff1a; 因地制宜&#xff0c;扬长避短 司马迁在文中详细描述了各地的地理特点和经济特色&#xff1a; 齐国临海&#xff0c;适合经商和渔业蜀地物产丰富&#xff0c;适合手工业中原地区适合农业边塞地区适合畜…

CSS基础知识六(浮动的高度塌陷问题及解决方案)

目录 1.浮动高度塌陷概念 2.下面是几种解决高度塌陷的几种方案&#xff1a; 解决方案一&#xff1a; 解决方案二&#xff1a; 解决方案三&#xff1a; 1.浮动高度塌陷概念 在CSS中&#xff0c;高度塌陷问题指的是父元素没有正确地根据其内部的浮动元素或绝对定位元素来计…

赛元MCU 脱机烧录步骤

烧录设置 生成烧录配置文件 载入配置文件 下载程序到烧录器中 并 对比 脱机烧录 1、 将SC-LINK 使用外部5V电源供电 2、将烧录口对准主板烧录接口 3、busy亮红灯&#xff0c;进入烧录ing&#xff0c;烧录成功后&#xff0c;OK灯亮蓝灯 注意事项 其中工程校验和 可以作为程序…

MATLAB-数学建模-无约束规划求解方法(非线性规划)

MATLAB-数学建模-无约束规划求解方法&#xff08;非线性规划&#xff09; fminbnd函数 其功能是求取固定区间内单变量函数的最小值&#xff0c;也就是一元函数的最小值问题。其数学模型为 minf(x),x1<x<x1 式中&#xff0c;x,x1,x2 均为标量&#xff1a;f(x)为目标函…

【手势识别】Python+卷积神经网络算法+人工智能+深度学习+计算机课设项目+TensorFlow+机器学习+Django网页界面+算法模型

一、介绍 手势识别系统&#xff0c;使用Python作为主要编程语言&#xff0c;通过收集了10种手势图片数据集&#xff08;0~9&#xff09;&#xff0c;然后基于TensorFlow搭建卷积神经网络算法模型&#xff0c;然后训练模型得到一个识别精度较高的模型文件&#xff0c;在基于Dja…

认识物联网

新一代信息技术 物联网 物物相连的互联网&#xff0c;即物联网&#xff0c;又称传感器常见的传感器 • 温度传感器 • 压力传感器 • 声音传感器 • 02 • */08521 物联网概念 • 通过射频识别&#xff0c;红外传感器&#xff0c;全球定位系统GPS&#xff0c;激光扫描…

大模型LLama3!!!Ollama下载、部署和应用(保姆级详细教程)

首先呢&#xff0c;大家在网站先下载ollama软件 这就和anaconda和python是一样的 废话不多说 直接上链接&#xff1a;Download Ollama on Windows 三个系统都支持 注意&#xff1a; 这里的Models&#xff0c;就是在上面&#xff0c;大家点开之后&#xff0c;里面有很多模型…

Gin入门笔记

1.基本数据类型 整型 类型占用存储空间int32位系统4字节64位系统8字节unint32位系统4字节64位系统8字节int81字节int162字节int324字节int648字节uint81字节uint162字节uint324字节uint648字节rune4字节(等价int32)byte1字节(等价unint8) Unicode字符rune类型是和int32等价的…