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

SpringBoot【十三(准备篇)】集成在线接口文档Swagger2

news 来源：原创 2025/6/27 5:03:59

一、前言🔥

环境说明：Windows10 + Idea2021.3.2 + Jdk1.8 + SpringBoot 2.3.1.RELEASE

二、swagger介绍

我就不卖关子啦，相信在座的各位很多都已经用过，但是没关系，只要全世界还有一个没用过，我都会给他讲。

那么，它究竟是何方神圣？登登登~，就是它啦，Swagger！

1、Swagger是什么？

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。而且它还是全球最大的OpenAPI规范（OAS）API开发工具框架，且支持从设计和文档到测试和部署的整个API生命周期的开发。

它的诞生，就是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。

2、为什么要用Swagger？

Swagger的目标是为REST APIs 定义一个标准的，与语言无关的接口，使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能。

当服务通过Swagger定义，消费者就能与远程的服务互动通过少量的实现逻辑。类似于低级编程接口，Swagger去掉了调用服务时的很多猜测。

3、Swagger有哪些重要特性？

代码侵入式注解
遵循YAML文档格式
非常适合三端（PC、iOS及Android）的API管理，尤其适合前后端完全分离的架构模式。
减少没有必要的文档，符合敏捷开发理念
功能强大。

这不比你手写接口文档香么？(发自灵魂一问)

那说到这，肯定很多小伙伴就蠢蠢欲动，跃跃欲试，坐立不安了，"这么好使，那不得赶紧教教我们，怎么用啊？"。

bug菌从容回答道："别急哈，容bug菌充个饥先，去去就回。"

十分钟过去了...

半个小时过去了...

... ...

一个小时过去后... ”好啦，兄弟萌，我来啦。“，那个男人终于回来了，"好啦，咱们接着往下看。"

三、集成Swagger

首先集成Swagger文档，需要做两步，请按如下操作进行：

1、pom引入对应的Swagger依赖包

<!--swagger2-->
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.7.0</version><!--排除传递性依赖(默认依赖指定版本的models跟annotations)，避免报错--><exclusions><exclusion><groupId>io.swagger</groupId><artifactId>swagger-annotations</artifactId></exclusion><exclusion><groupId>io.swagger</groupId><artifactId>swagger-models</artifactId></exclusion></exclusions>
</dependency><!--Swagger第三方ui-->
<dependency><groupId>com.github.xiaoymin</groupId><artifactId>swagger-bootstrap-ui</artifactId><version>1.9.2</version>
</dependency><!--提供Swagger API注解-->
<dependency><groupId>io.swagger</groupId> <artifactId>swagger-annotations</artifactId><version>1.5.21</version>
</dependency><dependency><groupId>io.swagger</groupId><artifactId>swagger-models</artifactId><version>1.5.21</version>
</dependency>

是不是觉得看着有点多，说实话也不多，等你体验了，你就不会觉得这有啥，如上就是Swagger依赖生态啦，基本需要用到的我都配了。由于原生UI界面不是很好看，我就给换了，你们也可以自己选择。

这是我是集成了xiaoymin开源的ui界面：可就很美观了呀，你们要是好奇，你们可以自己玩一下原生的ui是啥样子，这里就不一一给大家演示了哈

2、config文件配置

依赖都引用全了，接着就是要配置一下，指定几个属性及访问swagger界面url。

package com.example.demo.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;/*** swagger配置** @Author luoyong* @Date 2021-06-01 13:00*/
@Configuration //必须存在
@EnableSwagger2 //必须存在
public class SwaggerConfig {@Beanpublic Docket customDocket() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))//对应你controller目录.paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("swagger 接口文档")  //指定文档标题.contact(new Contact("luoyong", "", ""))  //指定作者.description("swagger-bootstrap-ui")  //接口文档描述.termsOfServiceUrl("http://localhost:8080") //指定在线接口文档访问url.version("1.0")  //指定版本号.build();}
}

都配置好后，咱们重启项目，然后浏览器输入url地址：http://localhost:8080/doc.html

你将会发现，这不就是我上方所截图的UI界面嘛。没错，这样就表明已经配置好啦。

至于如何具体结合你的业务接口进行文档在线展示，我将放在下期进行教学，敬请期待吧。

SpringBoot【十三(准备篇)】集成在线接口文档Swagger2

一、前言🔥 环境说明：Windows10 Idea2021.3.2 Jdk1.8 SpringBoot 2.3.1.RELEASE 二、swagger介绍我就不卖关子啦，相信在座的各位很多都已经用过，但是没关系，只要全世界还有一个没用过，我都会给他讲。那…...

编程日记 2025/6/27 5:03:59

CKA认证 | Day6 K8s网络

第六章 Kubernetes网络 1、Service 控制器在 Kubernetes (K8S) 中，Service 控制器是一个关键组件，负责管理 Kubernetes 服务的生命周期和实现其功能。Service 控制器确保服务能够正确地将流量路由到后端 Pod，并处理服务的负载均衡和 DNS …...

编程日记 2025/6/27 4:46:05

基于Llamaindex的网页内容爬取实战

目的本文不关注如何解析网页 html 元素和各种 python 爬虫技术，仅作为一种网页数据的预处理手段进行研究。Llamaindex 也并不是爬虫技术的集大成者，使用它是为了后续的存查一体化。安装依赖 pip install llama-index-readers-web # pip install llam…...

编程日记 2025/6/27 4:31:58

springboot429校运会管理系统(论文+源码)_kaic

摘要传统办法管理信息首先需要花费的时间比较多，其次数据出错率比较高，而且对错误的数据进行更改也比较困难，最后，检索数据费事费力。因此，在计算机上安装校运会管理系统软件来发挥其高效地信息处理的作用&#xff…...

编程日记 2025/6/21 22:29:17

https://github.com/westes/flex/releases/download/v2.6.4/flex-2.6.4.tar.gz tar -zxvf flex-2.6.4.tar.gz ./configure CFLAGS-D_GNU_SOURCE make sudo make installwget http://ftp.gnu.org/gnu/bison/bison-3.2.1.tar.gz ./configure make sudo make install以上两个库是…...

编程日记 2025/6/26 20:50:59

Vite快速构建Vue教程

步骤 1: 初始化项目目录创建一个名为 projects 的文件夹，作为存放所有 Vite 项目的根目录。这个文件夹将容纳多个独立的 Vite 项目。步骤 2: 创建 Vite 项目右键点击 projects 文件夹并选择“在此处打开终端”或使用您偏好的代码编辑器（如 VSCode&…...

编程日记 2025/6/25 10:34:01

四、个人项目系统搭建

文章目录一、python写的后端代码二、html代码三、index.css四、js代码效果图： 一、python写的后端代码后端代码使用Flask编写，如下所示： # app.py from flask import Flask, render_template, request, jsonify, g import sqlite3 import…...

编程日记 2025/6/24 1:40:35

长沙理工大学《2024年825自动控制原理真题》 (完整版）

本文内容，全部选自自动化考研联盟的：《长沙理工大学825自控考研资料》的真题篇。后续会持续更新更多学校，更多年份的真题，记得关注哦~ 目录 2024年真题 Part1：2024年完整版真题 2024年真题...

编程日记 2025/6/2 17:46:01

Linux上安装Anaconda

查看版本 lsb_release -a uname -m x86_64：表示系统是64位。i686、i386：表示系统是32位。到连接安装对应版本连接到ldhttps://repo.anaconda.com/archive/ 配置对应的conda环境，export PATH/对应目录/anaconda3/bin:$PATH *注意为bi…...

编程日记 2025/6/24 18:22:29

HTTP常见的请求头有哪些？都有什么作用？在 Web 应用中使用这些请求头？

HTTP 请求头（Request Headers）用于在 HTTP 请求中携带额外的信息，帮助服务器更好地处理请求。以下是一些常见的 HTTP 请求头及其作用： 常见请求头及其作用 1. Accept 作用：告知服务器客户端可以接受的内容类型。示例…...

编程日记 2025/6/26 14:03:51

扩展tinyplay使其自适应不同声道数量的媒体

android原来的tinyplay代码，如果遇到播放媒体的升到数量与打开pcm的声道数量不匹配的情况，会没法继续播放。本例扩展了tinyplay的代码，将不同声道的音频数据展开/压缩到pcm设备支持的数据，再写入pcm设备。 bplay.c #include &l…...

编程日记 2025/6/24 18:07:17

[Unity] AppLovin Max接入Native 广告 IOS篇

NativeIOS构建流程 （接入之前备份之前打包得Xcode工程） 下载资源 1.将以下文件放入Unity Assets->Plugins->IOS文件夹下 2.Unity更新max版本至12.4.1 UnityPlugin 6.4.3以上（很重要） 3.NativeSDKManager.CS根据以下附…...

编程日记 2025/6/26 17:45:11

跨平台开发技术的探索：从 JavaScript 到 Flutter

随着多平台支持和用户体验一致性在应用程序开发中变得越来越重要，开发者面临的挑战是如何在不同平台上保持代码的可维护性和高效性。本文将探讨如何利用现代技术栈，包括 Flutter、JavaScript、HTML5、WebAssembly、TypeScript 和 Svelte，在统一的平台上进行高效的跨平台开发…...

编程日记 2025/6/26 7:08:30

计算机网络技术基础：2.计算机网络的组成

计算机网络从逻辑上可以分为两个子网：资源子网和通信子网。一、资源子网资源子网主要负责全网的数据处理业务，为全网用户提供各种网络资源与网络服务。资源子网由主机、终端、各种软件资源与信息资源等组成。 1）主机主机是资源子网的主要…...

编程日记 2025/6/25 14:28:41

PKCS#7、Bit padding（位填充）、Byte padding（字节填充）、Zero padding（零填充）

PKCS#7、Bit padding（位填充）、Byte padding（字节填充）、Zero padding（零填充）是密码学常见的填充方式。 Bit padding（位填充）： 位填充可以应用于任意长度的消息。在消息…...

编程日记 2025/6/21 19:17:53

在 Kibana 中为 Vega Sankey 可视化添加过滤功能

作者：来自 Elastic Tim Bosman 及 Miloš Mandić 有兴趣在 Kibana 中为 Vega 可视化添加交互式过滤器吗？了解如何利用 “kibanaAddFilter” 函数轻松创建动态且响应迅速的 Sankey 可视化。在这篇博客中，我们将了解如何启用 Vega Sankey 可视…...

编程日记 2025/6/26 11:26:47

快速部署一套K8s集群-v1.28

快速部署一套K8s集群-v1.28 1.前置知识点 1.1 生产环境可部署Kubernetes集群的两种方式目前生产部署Kubernetes集群主要有两种方式： kubeadmKubeadm是一个K8s部署工具，提供kubeadm init和kubeadm join，用于快速部署Kubernetes集群。二进制包从github下载发行版的二进…...

编程日记 2025/6/23 8:52:26

python3验证有效正则表达式

Python 中字符串类型本质上没有标记“是否原始”的特性，原始字符串只是为了书写方便。运行时，原始字符串与普通字符串的表现是相同的，唯一的区别是编写代码时是否进行了转义。因此，如果需要确保某些输入是有效正则表达式&#x…...

编程日记 2025/6/25 1:38:36

Dify+Xinference本地部署Embedding和Rerank模型

文章目录 1、Xinference介绍2、Xinference安装2.1 Xinference Docker安装2.2 pip安装2.3 设置开启自启动（仅针对pip安装用户） 3、部署Embedding和Rerank模型4、Dify调用Xinference模型 1、Xinference介绍 ‌Xinference‌是一个性能强大且功能全面的分布…...

编程日记 2025/6/25 22:25:43

是时候戒掉小游戏了

玩儿这东西没够！去年本来是要备考CPA，但是赶上写毕业论文，就以此为由，没有去备考，结果论文没完成，考试也没准备，都是游戏惹的祸！今年计划备考，看了两个月书，结…...

编程日记 2025/6/23 12:30:56

ECMAScrip 与 ES2015（ES6）：JavaScript 现代化编程的里程碑

在 JavaScript 的发展历程中，ECMASCript 和 ES2015（也称为 ES6）无疑是最具革命性的版本之一。它们不仅引入了大量的新特性和语法糖，还极大地提升了代码的可读性、可维护性和性能。本文将深入探讨 ECMASCrip 和 ES2015 的新特性及其…...

编程日记 2025/6/26 10:24:38

iOS swift开发系列 -- tabbar问题总结

1.单视图如何改为tabbar，以便显示2个标签页右上角➕，输入tabbar 找到控件，然后选中，把entrypoint移动到tabbar控件 2.改成tabbar，生成两个item，配置各自视图后，启动发现报错 Thread 1: “-[p…...

编程日记 2025/6/20 16:33:12

nginx 部署 ModSecurity3

一、查看本地nginx版本 nginx是yum安装的 # nginx -v nginx version: nginx/1.26.2 二、安装依赖工具 # yum install -y gcc-c flex bison yajl lmdb lua curl-devel curl GeoIP-devel zlib-devel pcre-devel pcre2-devel libxml2-devel ssdeep-devel libtool autoconf aut…...

编程日记 2025/6/22 15:13:36

websocket_asyncio

WebSocket 和 asyncio 指南简介本指南涵盖了使用 Python 中的 websockets 库进行 WebSocket 编程的基础知识，以及 asyncio 在异步非阻塞 I/O 中的作用。它提供了构建高效 WebSocket 服务端和客户端的知识，以及 asyncio 的特性和优势。 1. 什么是 WebS…...

编程日记 2025/6/23 1:30:52

一级考试真题（2019）

一级考试真题（2019）...

编程日记 2025/5/30 13:30:02

OpenCV相机标定与3D重建(20)将单应性矩阵分解为旋转矩阵、平移向量和法向量函数decomposeHomographyMat()的使用

操作系统：ubuntu22.04 OpenCV版本：OpenCV4.9 IDE:Visual Studio Code 编程语言：C11 算法描述将单应性矩阵分解为旋转矩阵、平移向量和法向量。 cv::decomposeHomographyMat 是 OpenCV 库中的一个函数，用于将单应性矩阵&#xf…...

编程日记 2025/6/25 23:45:13

题解 - 取数排列

题目描述取1到N共N个连续的数字（1≤N≤9），组成每位数不重复的所有可能的N位数，按从小到大的顺序进行编号。当输入一个编号M时，就能打印出与该编号对应的那个N位数。例如，当N＝3时，可…...

编程日记 2025/6/24 19:08:44

LVGL9.2 鼠标悬停处理

文章目录前言鼠标悬停处理功能简介使用场景1. **按钮悬停效果**2. **图标高亮**3. **动态工具提示** 实现原理使用方法1. 设置控件样式2. 监听悬停事件功能亮点注意事项总结前言在 v9.2 版本中，新增了许多功能，其中鼠标悬停处理（Mouse H…...

编程日记 2025/6/25 15:46:00

每日计划-1213

1. 完成 SQL2 查询多列 https://www.nowcoder.com/exam/oj?page1tabSQL%E7%AF%87topicId199 2. 八股部分 1) C 中面向对象编程如何实现数据隐藏？ 在c中，可以将数据成员声明为私有或受保护，并提供公有的成员函数来访问和修改这些数据成员&am…...

编程日记 2025/6/23 17:15:26

gz中生成模型

生成模型通过服务调用生成还记得parameter_bridge 吗？ 我们在生成桥接的时候调用了这个cpp文件。一个 parameter_bridge 实例用于消息传递（传感器数据）。之前的例子另一个 parameter_bridge 实例用于服务桥接（动态生成模型…...

编程日记 2025/6/24 14:34:05

三相电机不转，如何判断好坏？

在现代工业生产中，三相电机被广泛应用于各类机械设备中，由于其高效能和稳定性，成为驱动设备的首选。然而，在实际使用过程中，三相电机有时会出现不转动的情况，这不仅会影响生产效率，还可能对设备…...

编程日记 2025/6/23 19:51:44

使用观测云排查数据库死锁故障

故障发现核心应用 pod 发生重启，同时接收到对应使用者反馈业务问题，开始排查。观测云排查现场 1、根据重启应用信息，查询 APM 执行数据库 update 操作大量报错，执行时间在 5min 以上。分析 APM 链路异常，发现是触…...

编程日记 2025/6/25 5:22:34

STM32 USB通信知识与应用详解

在嵌入式系统开发中，STM32作为一款性能卓越的微控制器，其USB通信功能的应用十分广泛。本文将深入探讨STM32 USB的相关知识，从基础概念到实际应用，为读者呈现一个全面的STM32 USB通信知识体系。一、USB基础知识 USB（…...

编程日记 2025/6/23 19:16:00

IoTDB 集群扩容方法

问题问题1：当时序数据库 IoTDB 集群的存储占用达到多少时，建议增加节点？是等到存储完全满，还是达到一半时就进行扩容？如果集群存储已满，是否需要手动进行数据清理，比如设置 TTL，还…...

编程日记 2025/6/26 3:40:09

控制台报错：Uncaught (in promise)：XXXXX问题定位以及前端文件流excel文件下载方法

今天对接上传文件的接口时，明明接口是通的，也正常返回了文件流，然而，控制台就是打印不出返回值，而且一直报错Uncaught (in promise)：XXXXX 去查看axios的封装函数，这个internal error是从返回值…...

编程日记 2025/6/24 17:22:44

.NET平台使用C#设置Excel单元格数值格式

设置Excel单元格的数字格式是创建、修改和格式化Excel文档的关键步骤之一，它不仅确保了数据的正确表示，还能够增强数据的可读性和专业性。正确的数字格式可以帮助用户更直观地理解数值的意义，减少误解，并且对于自动化报告生成、财…...

编程日记 2025/6/26 16:42:37

6.2 MapReduce工作原理

MapReduce工作原理涉及将大数据集分割成小块并行处理。Map任务读取数据块并输出中间键值对，而Reduce任务则处理这些排序后的数据以生成最终结果。MapTask工作包括读取数据、应用Map函数、收集输出、内存溢出时写入磁盘以及可选的Combiner局部聚合。ReduceTask工作则…...

编程日记 2025/6/23 4:19:35

C语言指针

1，指针是什么指针是内存中一个最小内存单元（一个字节）的编号，也就是地址通常口语中说的指针，通常是指指针变量也就是用来存放内存中地址的变量每个内存单元都有一个地址，这个地址不需要存起来&#xff0…...

编程日记 2025/6/25 14:45:30

前端(async 和await)

1 async async 将 function 变为成为 async 函数 ●async 内部可以使用 await，也可以不使用，因此执行这个函数时，可以使用 then 和 catch 方法 ●async 函数的返回值是一个 Promise 对象 ●Promise 对象的结果由 async 函数执行的返回值决…...

编程日记 2025/6/24 14:03:26

打造高效的HIS与DAT文件解析工具

在工业数据采集和存储中，HIS 和 DAT 文件是非常常见的二进制数据格式。然而，解析这些固定块大小的二进制文件并将其转换为易读的 CSV 格式并非易事。本文将深入讲解如何使用 Python 和 PyQt5 打造一款图形化工具，轻松解析和转换这些文件&…...

编程日记 2025/6/26 23:55:05

YOLO系列：二、基于yolov8和labelme制作数据集及模型训练

YOLO系列：二、基于yolov8和labelme制作数据集及模型训练 1.新建一个项目1.数据集标注及类型转换1. 1 使用labelme进行数据标注1.1.1打开labelme1.1.2图像标注及存储 1. 2 将数据集转换成yolo类型 2.模型训练的配置文件2. 1打开labelme标注图像2.1.1三级目录 3.模型训…...

编程日记 2025/6/26 13:47:23

PHP搭建环境

一、安装apache 1、获取Apache安装软件 2、双击安装即可：指定对应的路径：E：server/apache 3、选择安装模式：使用自定义模式 4、选择安装位置二、Apache的目录结构说明三、Httpd.exe的详细应用 1、服务器进程：运行之后才能够工作...

编程日记 2025/6/23 1:35:15

LeetCode hot100-69-N

https://leetcode.cn/problems/valid-parentheses/description/?envTypestudy-plan-v2&envIdtop-100-liked 20. 有效的括号已解答简单相关标签相关企业提示给定一个只包括 (，)，{，}，[，] 的字符串 s &#x…...

编程日记 2025/6/26 21:41:44

14：00面试，14：06就出来了，问的问题有点变态。。。

从小厂出来，没想到在另一家公司又寄了。到这家公司开始上班，加班是每天必不可少的，看在钱给的比较多的份上，就不太计较了。没想到5月一纸通知，所有人不准加班，加班费不仅没有了，薪资还要降40%…...

编程日记 2025/6/24 19:53:42

ubuntu20.04复现 Leg-KILO

这里写目录标题 opencv版本问题下载3.2.0源代码进入解压后的目录创建构建目录运行 CMake 配置配置时指定一个独立的安装目录，例如 /opt/opencv-3.2：出错： 使用多线程编译错误1： stdlib.h: 没有那个文件或目录错误2：er…...

编程日记 2025/6/26 16:37:24

Redis应用—1.在用户数据里的应用

大纲 1.社区电商的业务闭环 2.Redis缓存架构的典型生产问题 3.用户数据在读多写少场景下的缓存设计 4.热门用户数据的缓存自动延期机制 5.缓存惊群与穿透问题的解决方案 6.缓存和数据库双写不一致问题分析 7.基于分布式锁保证缓存和数据库双写一致性 8.缓存和数据库双写…...

编程日记 2025/6/22 14:59:10

MySQL InnoDB 中的数据页

文章目录 1. 数据库的存储结构概述1.1 表空间（Tablespace）1.2 段（Segment）1.3 区（Extent）1.4 页（Page） 2. InnoDB 数据页的深入解析2.1 数据页的物理结构2.2 数据页中的行存储2.3 数…...

编程日记 2025/6/26 10:41:32

React Fiber

React Fiber 是 React 16 引入的全新重写的协调（Reconciliation）算法的实现，旨在改善 React 的更新机制和性能，尤其是在复杂应用和大量更新的场景下。它使得 React 更加灵活、可调度，能够实现优先级控制和中断更新等特…...

编程日记 2025/6/26 7:51:06

hive 小文件分析

1、获取fsimage文件： hdfs dfsadmin -fetchImage /data/xy/ 2、从二进制文件解析： hdfs oiv -i /data/xy/fsimage_0000000019891608958 -t /data/xy/tmpdir -o /data/xy/out -p Delimited -delimiter “,” 3、创建hive表 create database if not exists…...

编程日记 2025/6/23 1:36:15

大模型运用-Prompt Engineering（提示工程）

什么是提示工程提示工程提示工程也叫指令工程，涉及到如何设计、优化和管理这些Prompt，以确保AI模型能够准确、高效地执行用户的指令，如：讲个笑话、java写个排序算法等使用目的 1.获得具体问题的具体结果。（如&…...

编程日记 2025/6/26 16:36:55