Spring Boot 3项目集成Swagger3教程

Spring Boot 3项目集成Swagger3教程

🌟 前言

欢迎来到我的小天地，这里是我记录技术点滴、分享学习心得的地方。📚

🛠️ 技能清单
  • 编程语言：Java、C、C++、Python、Go、
  • 前端技术：Jquery、Vue.js、React、uni-app、Echarts
  • UI设计: Element-ui、Antd、Color-ui
  • 后端技术：Spring Boot、Mybatis-plus、Swagger
  • 移动开发：Android
  • 操作系统：Windows、Linux
  • 开发框架：RuoYi、微信小程序
  • 开发工具：VSCode、IDEA、Eclipse、WebStorm、HbuildX、Navicat、Xshell、Android Studio、Postman
  • 数据库技术：MySQL、Redis、SQL Server
  • 版本控制：Git

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

1. 添加依赖

首先，您需要在项目的pom.xml文件中添加Swagger3的依赖。同时，为了确保依赖能够正确下载，您可以添加阿里云的Maven镜像仓库。

        <!--swagger3--><dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId><version>4.1.0</version></dependency><repositories><!--阿里云镜像--><repository><id>alimaven</id><name>aliyun maven</name><url>https://maven.aliyun.com/nexus/content/groups/public/</url><releases><enabled>true</enabled></releases><snapshots><enabled>true</enabled></snapshots></repository></repositories>

2. 配置Swagger

在Spring Boot项目中创建一个配置类SwaggerConfig，并添加Swagger的配置信息。

import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;@Configuration
public class SwaggerConfig {@Beanpublic OpenAPI springShopOpenAPI() {return new OpenAPI().info(new Info().title("标题").contact(new Contact()).description("我的API文档").version("v1").license(new License().name("Apache 2.0").url("http://springdoc.org"))).externalDocs(new ExternalDocumentation().description("外部文档").url("https://springshop.wiki.github.org/docs"));}
}

3. 实体类和控制层注解

在您的实体类和控制层中使用Swagger注解来描述API。

// 实体类注解示例
import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.annotation.write.style.ColumnWidth;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;import java.util.Date;@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@Accessors(chain = true)
@Schema(name = "Employee", description = "$!{table.comment}")
public class Emp {@ExcelProperty("ID")@Schema(description = "ID")private int id;@ExcelProperty("用户名")@Schema(description = "用户名")private String names;@ExcelProperty("工资")@Schema(description = "工资")private double salary;@ExcelProperty("生日")@Schema(description = "生日")private Date birthday;@ColumnWidth(20)@ExcelProperty("头像")@Schema(description = "头像")private String photo;//    @ColumnWidth(20)
//    @DateTimeFormat("yyyy-MM-dd HH:mm:ss")
//    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
//    @ExcelProperty("创建日期")
//    private Date u_create_time;
}// 控制层注解示例
import io.swagger.v3.oas.annotations.Operation;@Operation(summary = "获取所有员工信息")
@GetMapping("/selectAll")
public List<Emp> selectAll() {// ...
}

4. 通用返回结果封装

创建一个通用的返回结果类，用于统一API的响应格式。

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Getter;
import lombok.Setter;
import lombok.extern.slf4j.Slf4j;@Builder(toBuilder = true)
@AllArgsConstructor
@Setter
@Getter
@Slf4j
public class Result<T> {/*** 提示信息*/@Schema(description = "提示信息")private String message;/*** 是否成功*/@Schema(description = "是否成功")private boolean success;/*** 返回状态码*/@Schema(description = "返回状态码")private Integer code;/*** 数据*/@Schema(description = "数据")private T data;public Result() {}public static Result success() {Result Result = new Result();Result.setSuccess(Boolean.TRUE);Result.setCode(ResultCode.SUCCESS.getCode());Result.setMessage(ResultCode.SUCCESS.getMsg());return Result;}public static Result success(String msg) {Result Result = new Result();Result.setMessage(msg);Result.setSuccess(Boolean.TRUE);Result.setCode(ResultCode.SUCCESS.getCode());return Result;}public static Result success(Object data) {Result Result = new Result();Result.setData(data);Result.setSuccess(Boolean.TRUE);Result.setCode(ResultCode.SUCCESS.getCode());Result.setMessage(ResultCode.SUCCESS.getMsg());return Result;}/*** 返回失败 消息** @return Result*/public static Result failure() {Result Result = new Result();Result.setSuccess(Boolean.FALSE);Result.setCode(ResultCode.FAILURE.getCode());Result.setMessage(ResultCode.FAILURE.getMsg());return Result;}/*** 返回失败 消息** @param msg 失败信息* @return Result*/public static Result failure(String msg) {Result Result = new Result();Result.setSuccess(Boolean.FALSE);Result.setCode(ResultCode.FAILURE.getCode());Result.setMessage(msg);return Result;}public static Result failure(Integer code, String msg) {Result Result = new Result();Result.setSuccess(Boolean.FALSE);Result.setCode(code);Result.setMessage(msg);return Result;}public static Result failure(String msg, ResultCode exceptionCode) {Result Result = new Result();Result.setMessage(msg);Result.setSuccess(Boolean.FALSE);Result.setCode(exceptionCode.getCode());Result.setData(exceptionCode.getMsg());return Result;}/*** 返回失败 消息** @param exceptionCode 错误信息枚举* @return Result*/public static Result failure(ResultCode exceptionCode) {Result Result = new Result();Result.setSuccess(Boolean.FALSE);Result.setCode(exceptionCode.getCode());Result.setMessage(exceptionCode.getMsg());return Result;}/*** 返回失败 消息** @param exceptionCode 错误信息枚举* @param msg           自定义错误提示信息* @return Result*/public static Result failure(ResultCode exceptionCode, String msg) {Result Result = new Result();Result.setMessage(msg);Result.setSuccess(Boolean.FALSE);Result.setCode(exceptionCode.getCode());return Result;}}

5. 注解说明

Swagger3的注解与Swagger2有所不同，以下是一些常用注解的对照表：

Swagger2注解Swagger3注解注解位置
@Api@Tag(name = “接口类描述”)Controller类上
@ApiOperation@Operation(summary = “接口方法描述”)Controller方法上
@ApiImplicitParams@ParametersController方法上
@ApiImplicitParam@Parameter(description = “参数描述”)Controller方法上
@ApiParam@Parameter(description = “参数描述”)方法参数上
@ApiIgnore@Parameter(hidden = true) 或 @Operation(hidden = true)-
@ApiModel@SchemaDTO类上
@ApiModelProperty@SchemaDTO属性上

6. 访问Swagger UI

启动您的Spring Boot应用后，您可以通过以下地址访问Swagger UI：

http://localhost:8080/doc.html
http://localhost:8080/swagger-ui/index.html

在这里，您可以查看API文档，测试API接口，并获取相关信息。

🚀 获取源代码

  • 后端案例：https://gitee.com/bestwishes0203/Front-end-example
  • 前端案例：https://gitee.com/bestwishes0203/Back-end-example

📌 联系方式

如果您对我们的项目感兴趣，或者有任何技术问题想要探讨，欢迎通过以下方式与我联系。我非常期待与您交流，共同学习，共同进步！

  • 邮箱：2109664977@qq.com
  • Gitee：https://gitee.com/bestwishes0203
  • GitHub：https://github.com/bestwishes0203
  • CSDN：https://blog.csdn.net/interest_ing_/
  • 个人博客：访问我的博客

🎉 结语

感谢你的访问，如果你对我的技术文章或项目感兴趣，欢迎通过以上方式与我联系。让我们一起在技术的道路上不断前行！🚀

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/728974.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

智慧灯杆-智慧城市照明现状分析（2）

智慧灯杆-智慧城市照明现状分析（2）

作为城市照明的主体，城市道路照明伴随着我国城市建设的高速发展，获得了快速的增长。国家统计局数据显示，从2004年至2014年，我国城市道路照明灯数量由1053.15万盏增加到3000万盏以上，年均复合增长率超过11%，城市道路照明行业保持持续快速发展的趋势。 近几年，随着中国路灯…
阅读更多...
Lua学习笔记：分享一个用纯Lua写的位操作（异或）

Lua学习笔记：分享一个用纯Lua写的位操作（异或）

前言 Lua在5.3版本之前没有进行位操作的运算符&#xff0c;如果想用一些位操作没有那么容易&#xff0c;可以使用BIt库来处理&#xff0c;这里分享几个使用纯Lua写的异或运算 local floor math.floor function bxor (a,b)local r 0for i 0, 31 dolocal x a / 2 b / 2if x…
阅读更多...
如何排查合并问题——《OceanBase诊断系列》之七

如何排查合并问题——《OceanBase诊断系列》之七

1. 前言 OceanBase数据库的存储引擎以 LSM-Tree 架构为基础&#xff0c;区分静态基线数据&#xff08;存储在只读SSTable&#xff09;和动态增量数据&#xff08;存储在可读写MemTable&#xff09;。其中 SSTable 是只读的&#xff0c;一旦生成就不再被修改&#xff0c;存储于…
阅读更多...
C++程序设计-第四/五章 函数和类和对象【期末复习|考研复习】

C++程序设计-第四/五章 函数和类和对象【期末复习|考研复习】

前言 总结整理不易&#xff0c;希望大家点赞收藏。 给大家整理了一下C程序设计中的重点概念&#xff0c;以供大家期末复习和考研复习的时候使用。 文章目录 前言第四章 函数 函数和类和对象4.1 说明带参数的宏与内联函数有什么不同4.2 全局变量和局部变量有什么区别是怎么实现的…
阅读更多...
2024年华为OD机试真题-停车场车辆统计-Java-OD统一考试（C卷）

2024年华为OD机试真题-停车场车辆统计-Java-OD统一考试（C卷）

题目描述： 特定大小的停车场，数组cars[]表示，其中1表示有车，0表示没车。车辆大小不一，小车占一个车位（长度1），货车占两个车位（长度2），卡车占三个车位（长度3），统计停车场最少可以停多少辆车，返回具体的数目。 输入描述： 整型字符串数组cars[]，其中1表示有车，0…
阅读更多...
C语言-----qsort函数的功能以及模拟实现

C语言-----qsort函数的功能以及模拟实现

1.冒泡排序 &#xff08;1&#xff09;冒泡排序就是数据两个两个的进行比较每一趟都是一个数和其他的所有的数字比较&#xff0c; &#xff08;2&#xff09;这个要的是升序排列&#xff0c;所以前面的大的话&#xff0c;就会调换位置 &#xff08;3&#xff09;冒泡排序的缺…
阅读更多...
【开源】JAVA+Vue.js实现高校宿舍调配管理系统

【开源】JAVA+Vue.js实现高校宿舍调配管理系统

目录 一、摘要1.1 项目介绍1.2 项目录屏 二、功能需求2.1 学生端2.2 宿管2.3 老师端 三、系统展示四、核心代码4.1 查询单条个人习惯4.2 查询我的室友4.3 查询宿舍4.4 查询指定性别全部宿舍4.5 初次分配宿舍 五、免责说明 一、摘要 1.1 项目介绍 基于JAVAVueSpringBootMySQL的…
阅读更多...
【C语言基础】：深入理解指针(三)

【C语言基础】：深入理解指针(三)

文章目录 深入理解指针一、冒泡排序二、二级指针三、指针数组3.1 指针数组模拟二维数组 四、字符指针变量五、数组指针变量5.1 数组指针变量是什么&#xff1f;5.2 数组指针变量的初始化 六、二维数组传参的本质 深入理解指针 指针系列回顾&#xff1a; 【C语言基础】&#xf…
阅读更多...
L2-008 最长对称子串(java题解）

L2-008 最长对称子串(java题解）

对给定的字符串&#xff0c;本题要求你输出最长对称子串的长度。例如&#xff0c;给定Is PAT&TAP symmetric?&#xff0c;最长对称子串为s PAT&TAP s&#xff0c;于是你应该输出11。 输入格式&#xff1a; 输入在一行中给出长度不超过1000的非空字符串。 输出格式&a…
阅读更多...
JavaScript 中的 sort 传入 (a,b) =＞ b - a 会是升序还是降序？为什么呢？

JavaScript 中的 sort 传入 (a,b) =＞ b - a 会是升序还是降序？为什么呢？

在 JavaScript 中的数组有内建的 sort 方法，可以让我们不用自己手写排序算法，也能够有高效能的排序方法可用。然而，你知道sort 要怎么用吗? 在sort 中要传入的compareFn 又是如何运作的? 当compareFn 是(a, b) => b - a 时，排序会是升序还是降序? 为什么呢? 这一连…
阅读更多...
用户登录问题——登录态

用户登录问题——登录态

不论在任何系统中&#xff0c;用户体系都是重中之重&#xff0c;而怎么建立一个完善的&#xff0c;安全的用户体系&#xff0c;是所有开发者都在思考的问题。 而这里就来思考一下&#xff0c;用户登录问题。 登录的作用主要就是用户认证&#xff0c;与权限认证&#xff0c;也…
阅读更多...
云原生周刊：CNCF 宣布 Falco 毕业｜2024.3.4

云原生周刊：CNCF 宣布 Falco 毕业｜2024.3.4

开源项目推荐 ldap-operator 用于部署和管理 LDAP 目录的 Kubernetes Operator。 Updatecli Updatecli 是一个用于应用文件更新策略的工具。每个应用程序“运行”时都设计为可在任何地方使用&#xff0c;它会检测是否需要使用自定义策略更新值&#xff0c;然后根据该策略应…
阅读更多...
UOS 与 Ubuntu 命令行打开安装包界面，双击打开界面调用安装包界面展示

UOS 与 Ubuntu 命令行打开安装包界面，双击打开界面调用安装包界面展示

UOS 使用deepin-deb-installer安装程序 deepin-deb-installer xxxxxxx.deb & Ubuntu snap-store --local-filename /home/seven/wps-office_1xxxxxxx.deb &
阅读更多...
ubuntu20.04安装ros并配置相关环境以及驱动AUBO i5机械臂

ubuntu20.04安装ros并配置相关环境以及驱动AUBO i5机械臂

ubuntu20.04安装ros并配置相关环境以及驱动AUBO i5机械臂 安装ros安装rosdep(小鱼的rosdepc,又快又好用)环境配置下载并编译aubo roslib库环境变量配置aubo gazeboaubo rviz驱动真实机械臂 安装ros 搜索鱼香ros网站https://fishros.com/&#xff0c;根据一键安装ros里提供的指…
阅读更多...
【数据结构】二、线性表：1.顺序表的定义与实现（静态分配、动态分配）

【数据结构】二、线性表：1.顺序表的定义与实现（静态分配、动态分配）

文章目录 线性表linear list基本操作1.顺序表1.1静态分配1.2动态分配 线性表linear list 线性表是具有相同数据类型的n (n≥0&#xff09;个数据元素的有限序列&#xff0c;其中n为表长&#xff0c;当n0时线性表是一个空表。 若用L命名线性表&#xff0c;则其一般表示为&#…
阅读更多...
自动填充MyBatis-Plus日志中的sql语句参数小工具

自动填充MyBatis-Plus日志中的sql语句参数小工具

写在前面&#xff1a;大家好&#xff01;我是晴空๓。如果博客中有不足或者的错误的地方欢迎在评论区或者私信我指正&#xff0c;感谢大家的不吝赐教。我的唯一博客更新地址是&#xff1a;https://ac-fun.blog.csdn.net/。非常感谢大家的支持。一起加油&#xff0c;冲鸭&#x…
阅读更多...
Chromium内核浏览器编译记（四）Linux版本CEF编译

Chromium内核浏览器编译记（四）Linux版本CEF编译

转载请注明出处&#xff1a;https://blog.csdn.net/kong_gu_you_lan/article/details/136508294 本文出自 容华谢后的博客 0.写在前面 本篇文章是用来记录编译Linux版本CEF的步骤和踩过的坑&#xff0c;以防止后续再用到的时候忘记&#xff0c;同时也希望能够帮助到遇到同样问…
阅读更多...
Crow 编译和环境搭建

Crow 编译和环境搭建

Crow与其说是编译&#xff0c;倒不如说是环境搭建。Crow只需要包含头文件&#xff0c;所以不用编译生成lib。 Crow环境搭建 boost&#xff08;可以不编译boost&#xff0c;只需要boost头文件即可&#xff09;asio &#xff08;可以不编译&#xff0c;直接包含头文件。不能直接…
阅读更多...
【Linux】软件管理器yum和编辑器vim

【Linux】软件管理器yum和编辑器vim

&#x1f525;博客主页&#xff1a; 小羊失眠啦. &#x1f3a5;系列专栏&#xff1a;《C语言》 《数据结构》 《C》 《Linux》 《Cpolar》 ❤️感谢大家点赞&#x1f44d;收藏⭐评论✍️ 文章目录 一、Linux下安装软件的方案1.1 源代码安装1.2 rpm安装1.3 yum安装 二、Linux软件…
阅读更多...
Spring Boot 配置热部署

Spring Boot 配置热部署

前言 对于 Spring Boot 项目之中, 在刚开始学习的时候, 每当代码进行变动的时候, 想要生效那就必须要手动重启. 为什么要重启呢 ? 原因在于写的代码是依靠运行之后的 class 文件运行的, 当我们的代码更新以后, 如果不去手动重启, 那么就无法生成新的 class 文件, 执行的就是旧…
阅读更多...
最新文章

Copyright @ 2022~2023