【视频版】最新版Swagger 3升级指南和新功能体验!(1)

简介: 【视频版】最新版Swagger 3升级指南和新功能体验!(1)

Swagger 是什么?


Swagger 是一个用于生成、描述和调用 RESTful 接口的 Web 服务。通俗的来讲,Swagger 就是将项目中所有(想要暴露的)接口展现在页面上,并且可以进行接口调用和测试的服务。


PS:Swagger 遵循了 OpenAPI 规范,OpenAPI 是 Linux 基金会的一个项目,试图通过定义一种用来描述 API 格式或 API 定义的语言,来规范 RESTful 服务开发过程。


Swagger 官网地址:https://swagger.io/


Swagger 有什么用?


从上述 Swagger 定义我们不难看出 Swagger 有以下 3 个重要的作用:


  1. 将项目中所有的接口展现在页面上,这样后端程序员就不需要专门为前端使用者编写专门的接口文档;


  1. 当接口更新之后,只需要修改代码中的 Swagger 描述就可以实时生成新的接口文档了,从而规避了接口文档老旧不能使用的问题


  1. 通过 Swagger 页面,我们可以直接进行接口调用,降低了项目开发阶段的调试成本


微信图片_20220120164142.jpg


Swagger 旧版本使用


Swagger 旧版本也就是目前市面上主流的 V2 版本是 Swagger 2.9.2,在讲新版本之前,我们先来回顾一下 Swagger 2.9.2 是如何使用的。


Swagger 2.9.2 的使用分为以下 4 步:


  1. 添加依赖


  1. 开启 Swagger 功能


  1. 配置 Swagger 文档摘要信息


  1. 调用接口访问


下面我们分别来看。


1.添加依赖


首先,我们要去 mvnrepository 查询 Swagger 的依赖,搜索“springfox”关键字,得到结果的前两条依赖信息,就是我们想要的结果,如下图所示:


微信图片_20220120164230.jpg


将这两个依赖添加带项目中:


<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>


相关文章
|
前端开发 Java Maven
升级 SpringBoot 2.6.x 版本后,Swagger 没法用了
最近想体验下最新版本的SpringBoot,逛了下官网,发现SpringBoot目前最新版本已经是2.6.4了,版本更新确实够快的。之前的项目升级了2.6.4版本后发现有好多坑,不仅有循环依赖的问题,连Swagger都没法用了!今天给大家分享下升级过程,填一填这些坑! 聊聊SpringBoot版本 首先我们来聊聊SpringBoot的版本,目前最新版本是2.6.4版本,2.7.x即将发布,2.4.x及以下版本已经停止维护了,目前的主流版本应该是2.5.x和2.6.x。具体可以看下面这张表。
|
Java Spring
【视频版】最新版Swagger 3升级指南和新功能体验!(3)
【视频版】最新版Swagger 3升级指南和新功能体验!(3)
312 0
【视频版】最新版Swagger 3升级指南和新功能体验!(3)
|
Java Spring
【视频版】最新版Swagger 3升级指南和新功能体验!(2)
【视频版】最新版Swagger 3升级指南和新功能体验!(2)
160 0
【视频版】最新版Swagger 3升级指南和新功能体验!(2)
|
监控 前端开发 Java
久违了,升级一波 swagger starter!
久违了,升级一波 swagger starter!
190 0
久违了,升级一波 swagger starter!
【视频版】最新版Swagger 3升级指南和新功能体验!(4)
【视频版】最新版Swagger 3升级指南和新功能体验!(4)
273 0
|
23天前
|
Java 测试技术 API
详解Swagger:Spring Boot中的API文档生成与测试工具
详解Swagger:Spring Boot中的API文档生成与测试工具
34 4
|
5月前
|
数据可视化 Java API
Spring Boot与Swagger的集成
Spring Boot与Swagger的集成
|
5月前
|
Java API 开发者
在Spring Boot中集成Swagger API文档
在Spring Boot中集成Swagger API文档
|
2月前
|
SQL JSON Java
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和PageHelper进行分页操作,并且集成Swagger2来生成API文档,同时定义了统一的数据返回格式和请求模块。
73 1
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
|
2月前
|
前端开发 Java 程序员
springboot 学习十五:Spring Boot 优雅的集成Swagger2、Knife4j
这篇文章是关于如何在Spring Boot项目中集成Swagger2和Knife4j来生成和美化API接口文档的详细教程。
191 1
下一篇
DataWorks