SpringBoot-SpringBoot整合Swagger使用教程(图文介绍,一篇就够了)

前言

日常开发中,接口都是和开发文档相结合的。不论是和前端对接还是三方对接亦或者是接口留档,当我们开发完接口后,都需要去创建对应的接口文档。而修改接口后也要修改相对应的接口文档,但是这个真的很容易疏漏。而且相对于繁重的开发任务而言,维护文档又是一个同样让人心累的事情。
那么有没有能针对我们的接口自动生成接口说明的工具呢,这样我们就不需要特意去生成和实时的去维护api文档?答案当然是-有,这就是今天要介绍的Swagger。

Swagger介绍

Swagger最初是由Tony Tam创建的一个开源项目,旨在提供一种描述RESTful API的标准化语言。随着时间的发展,Swagger逐渐演变成OpenAPI Specification(OAS),这是一个独立于任何特定实现的开放标准,用于描述RESTful Web服务。Swagger UI和Swagger Editor则是基于该规范的两个重要工具,它们分别用于可视化和编辑API文档。通过它们我们就可以实现自动生成和更新文档。

优点

1、标准化的API描述:
Swagger遵循OpenAPI规范,提供了一种标准化的方式来描述API,包括路径、方法、参数、响应等,这使得API文档易于理解且具有一致性。
2、交互式文档:
Swagger UI能够根据OpenAPI规范自动生成一个动态的、可交互的文档界面。开发者和用户可以直接在这个界面上尝试调用API,查看请求和响应示例,极大地提升了API的可用性和可测试性。
3、自动化生成客户端代码:
Swagger Codegen工具可以根据API的定义自动生成多种编程语言的客户端代码和服务器端接口代码,大大节省了开发时间。
4、简化文档维护:
因为API的描述与实际实现紧密相连,当API发生变化时,文档可以自动更新,避免了手动维护文档带来的不一致性和遗漏。
5、促进团队协作:
Swagger提供了一个共同的语言,使得开发人员、产品经理、测试人员和文档编写者能够基于同一套文档进行沟通,提高了团队的协同效率。
6、支持多语言和框架:
Swagger兼容多种后端技术和语言,如Java、Python、Node.js等,几乎可以无缝融入任何现有的技术栈。
7、便于API治理:
Swagger的标准化描述使得API的版本控制、权限管理、流量监控等治理工作变得更加容易和高效。

下面我们就来看一下如何在我们的项目中集成Swagger

添加pom依赖

说明:下面截图给出的非官方版本的UI依赖,至于为什么,博主稍后会给出解释。

在这里插入图片描述

        <!-- swagger的UI可视化界面 git版本--><dependency><groupId>com.github.xiaoymin</groupId><artifactId>swagger-bootstrap-ui</artifactId><version>1.8.1</version></dependency><!-- swagger的UI可视化界面 官方版本,注意版本号一致--><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.8.0</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version></dependency>

上面给出了两个不同版本的Swagger UI可视化界面依赖。首先最上面的是博主使用的git版本,下面给出的是官方版本UI界面,二者选择其一即可。二者界面区别下面单独给出。
注意:若选择官方UI界面,需要注意版本号问题,要下面的springfox-swagger2使用同一个版本号,否则会启动异常。

设置Swagger配置类

@Configuration
@EnableSwagger2
@Profile({"dev", "test", "local"}) // 设置swagger的使用环境(防止prod环境api泄露)
public class Swagger2Config {@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()// 对某些api进行监控
//或 .apis(RequestHandlerSelectors.basePackage(“com.springboot.demo”)).apis(RequestHandlerSelectors.withClassAnnotation(Api.class)).paths(PathSelectors.any()) // 对所有路径进行监控.build();}// 设置swagger的api相关信息private ApiInfo apiInfo() {return new ApiInfoBuilder().title("local-project-api").description("本地接口api").version("1.0").build();}}

官方UI界面

注意:启动类添加注解:@EnableSwagger2
访问路径:http://{ip}:{port}/swagger-ui.html

主界面

在这里插入图片描述

单个Api如下:

在这里插入图片描述

Git版本UI界面

访问路径:http://{ip}:{port}/doc.html

主界面

在这里插入图片描述

设置全局参数

在这里插入图片描述

单个API如下:

在这里插入图片描述

在这里插入图片描述

总的来说,Git版本的UI界面更和谐,布局也更合理。但也不是说官方版本的UI界面就多不好,仁者见仁智者见智,博主只是根据自己使用得出的个人见解,大家可以根据自己需要自由选择。

到这里就结束了,创作不易,若有问题欢迎指正~

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

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

相关文章

WEB攻防【6】——Python考点/CTF与CMS/SSTI模板注入/PYC反编译

#知识点 1、PYC文件反编译 2、python-web-SSTI 3、SSTI模板注入利用分析 SSTI 就是服务器端模板注入 &#xff08;Server-Side Template Injection&#xff09; 当前使用的一些框架&#xff0c;比如python的flask&#xff0c;php的tp&#xff0c;java的spring等一般都采用成…

jQuery的extend方法仅仅是字面意思上的扩展吗?

jQuery中extend的使用方式大多是这样的&#xff1a; jQuery.extend({// Unique for each copy of jQuery on the pageexpando: "jQuery" (version Math.random()).replace(/\D/g, ""),// Assume jQuery is ready without the ready moduleisReady: true,…

存储管理(三):分区表

什么是分区表 假设存在表t&#xff1a; CREATETABLE t (ftimedatetime NOT NULL,c int(11) DEFAULT NULL,KEY (ftime) )ENGINEInnoDB DEFAULT CHARSETlatin1 PARTITION BY RANGE (YEAR(ftime)) (PARTITION p_2017 VALUES LESS THAN (2017) ENGINE InnoDB,PARTITION p_2018 VA…

golang 获取系统的主机 CPU 内存 磁盘等信息

golang 获取系统的主机 CPU 内存 磁盘等信息 要求 需要go1.18或更高版本 官方地址&#xff1a;https://github.com/shirou/gopsutil 使用 #下载包 go get github.com/shirou/gopsutil/v3/cpu go get github.com/shirou/gopsutil/v3/disk go get github.com/shirou/gopsuti…

tr、cut、split、grep -E

目录 tr命令&#xff1a;替换和删除 cut命令&#xff1a;快速裁剪 split命令&#xff1a;文件拆分 文件合并 面试题 1.现在有一个日志文件&#xff0c;有5个G&#xff0c;能不能快速的打开 2.cat合并和paste合并之间的区别&#xff1f; 3.统计当前主机的连接状态&#…

Hadoop3:MapReduce中的Reduce Join和Map Join

一、概念说明 学过MySQL的都知道&#xff0c;join和left join 这里的join含义和MySQL的join含义一样 就是对两张表的数据&#xff0c;进行关联查询 Hadoop的MapReduce阶段&#xff0c;分为2个阶段 一个Map&#xff0c;一个Reduce 那么&#xff0c;join逻辑&#xff0c;就可以…

前端开发的工厂设计模式

在前端开发中&#xff0c;工厂设计模式&#xff08;Factory Pattern&#xff09;是一种非常有用的设计模式&#xff0c;能够帮助我们在创建对象时减少代码的重复性和复杂性。 一、工厂设计模式概述 工厂设计模式是一种创建型设计模式&#xff0c;主要目的是定义一个用于创建对…

2024年建筑八大员(资料员)考试题库,省心高效,轻松通过!

1.插入的图片无法显示&#xff0c;或者显示失真&#xff0c;正确做法是&#xff08;&#xff09;。 A.插人图片是应选中【自动调整图片大小】 B.在下拉【菜单】中选中【按单元格式大小】插入 C.在【格式】下拉中【图片】处打钩 D.在【属性】下拉中选中【工具显示】 答案&a…

机械培训元宇宙:开启未来教育与职业培训的新篇章

随着科技的飞速发展&#xff0c;特别是虚拟现实&#xff08;VR&#xff09;、增强现实&#xff08;AR&#xff09;和人工智能&#xff08;AI&#xff09;等先进技术的广泛应用&#xff0c;我们正逐渐步入一个全新的时代——元宇宙。在这个虚拟的、由无数个并行宇宙组成的世界中…

两张图片怎样拼在一起?将两张图片拼在一起的几种方法介绍

两张图片怎样拼在一起&#xff1f;拼接两张图片是一种常见的编辑技巧&#xff0c;能够将不同的视觉元素融合成一个整体&#xff0c;从而创造出更加生动和丰富的图像效果。无论是为了设计创意作品、制作社交媒体内容&#xff0c;还是简单地为个人相册增添趣味&#xff0c;掌握如…

Java锁

乐观锁 什么是乐观锁 每次去拿数据的时候都认为别人不会修改&#xff0c;更新的时候会判断别人是否更新过数据&#xff0c;通过版本来判断&#xff0c;如果数据被修改了就拒绝更新Java里面大量使用CAS&#xff0c;CAS就是属于乐观锁&#xff0c;性能较悲观锁有很大的提高。Atom…

Element-UI 并排显示多个 disabled按钮的时候, 不生效问题解决

目录 Element-UI 并排显示多个 disabled按钮的时候&#xff0c; 不生效问题解决 解决方法&#xff1a; 运行结果&#xff1a; Element-UI 并排显示多个 disabled按钮的时候&#xff0c; 不生效问题解决 解决方法&#xff1a; Element-UI 并排显示多个 disabled按钮的时候&a…

LeetCode.4寻找两个正序数组的中位数

问题描述 给定两个大小分别为 m 和 n 的正序&#xff08;从小到大&#xff09;数组 nums1 和 nums2。请你找出并返回这两个正序数组的中位数。 算法的时间复杂度应该为 O(log (mn)) 。 解题思路1 理解问题的关键是要意识到&#xff0c;对于一个已排序的数组或两个数组的合并…

hbase 优化节点进程停止方式

一、命令 /usr/local/fqlhadoop/hbase/bin/graceful_stop.sh 4.hadoop3.com日志&#xff1a; [biadmin4 ~]$ /usr/local/fqlhadoop/hbase/bin/graceful_stop.sh 4.hadoop3.com 2024-06-24T09:42:27 Disabling load balancer log4j:WARN No such property [maxBackupIndex] in…

spring boot 3.0.1多模块项目使用nacos动态配置

根pom文件增加&#xff0c;spring-cloud-alibaba包管理&#xff0c;注意版本spring-boot 3.0.3&#xff0c;spring-cloud-alibaba 2022.0.0.0-RC1 <?xml version"1.0" encoding"UTF-8"?> <project xmlns"http://maven.apache.org/POM/4.0…

学习笔记——交通安全分析10

目录 前言 当天学习笔记整理 4信控交叉口交通安全分析 结束语 前言 #随着上一轮SPSS学习完成之后&#xff0c;本人又开始了新教材《交通安全分析》的学习 #整理过程不易&#xff0c;喜欢UP就点个免费的关注趴 #本期内容接上一期09笔记 当天学习笔记整理 4信控交叉口交…

我的创作纪念日学期总结

&#x1f525;个人主页&#xff1a; Forcible Bug Maker &#x1f525;专栏&#xff1a; 关于博主 目录 &#x1f308;前言&#x1f525;我的期末考试&#x1f525;我的学期总结&#x1f525;对未来的展望&#x1f308;结语 &#x1f308;前言 本篇博客主要内容&#xff1a;博…

归并排序和计数排序

目录 1.归并排序1.1递归1.1基本思想1.2算法描述1.3画图解释1.4代码实现 1.2非递归 2.计数排序2.1基本思想2.2算法描述3.画图解释 1.归并排序 1.1递归 1.1基本思想 归并排序是建立在归并操作上的一种有效的排序算法。该算法是采用分治法&#xff08;Divide and Conquer&#xf…

【C++】动态内存管理new和delete

文章目录 一、C的内存管理方式二、new和delete的用法1.操作内置类型2.操作自定义内置类型 三、new和delete的底层实现1.operator new和operator delete函数2.new和delete的实现原理 四、定位new表达式五、malloc/free和new/delete的区别 一、C的内存管理方式 之前在C语言的动态…

kafka(四)消息类型

一、同步消息 1、生产者 同步发送的意思就是&#xff0c;一条消息发送之后&#xff0c;会阻塞当前线程&#xff0c;直至返回 ack。 由于 send 方法返回的是一个 Future 对象&#xff0c;根据 Futrue 对象的特点&#xff0c;我们也可以实现同 步发送的效果&#xff0c;只需在调…