Swagger工作流程的理解

简介: 现在的Java开发,一般都会用到API生成工具Open API,今天一位工作2年的小伙伴突然被问到Swagger工作流程,一下子无言以对。于是,来找到我,希望我能科普一下。今天,我给大家分享一下我的理解。

现在的Java开发,一般都会用到API生成工具Open API,今天一位工作2年的小伙伴突然被问到Swagger工作流程,一下子无言以对。于是,来找到我,希望我能科普一下。


今天,我给大家分享一下我的理解。

1、Swagger简介

记得多年以前,在Swagger还没有出现的时候,我还用自己手写的Maven插件,来实现自动生成API的功能。界面有点丑,给大家秀一下:

d4691bc6e0a71ae1c475be83a14fbbc9.png

df060dc54aa2f4b349a01d3579cb309a.png

当时,还想着开源,后来Swagger问世之后,我就把源码从github上下了。


Swagger 是一套基于 OpenAPI 规范构建的开源工具,可以帮助我们设计、构建、记录以及使用 Rest API。Swagger 主要包含了以下三个部分:

506afe9603576daf2447754359608305.png

Swagger Editor:基于浏览器的编辑器,我们可以使用它编写我们 OpenAPI 规范。


Swagger UI:它会将我们编写的 OpenAPI 规范呈现为交互式的 API 文档。


Swagger Codegen:它可以通过为 OpenAPI规范定义的任何 API 生成服务器存根和客户端 SDK 来简化构建过程。

2、为什么要使用 Swagger

在前后端分离开发以后,维持一份及时更新且完整的 Rest API 文档,能够极大的提高的开发效率。传统意义上的文档都是后端开发人员手动编写的,一般是以Doc或者是md等形式离线传播。而在开发阶段,接口修改非常频繁,就很难保证文档更新的及时性,久而久之就失去了参考意义,反而还会加大团建之间的沟通成本。

46b37e28d576e03d4fe0a90e44f04f35.png

04072c420d734422113ed5094fa9392d.png

而 Swagger 给我们提供了一个全新的维护 API 文档的方式,只要项目发布,就能够自动更新,而且可以同步到线上,使用者只需要记住一个固定的网址,实时刷新就能访问到最新版本的API文档了。下面我总结一下Swagger的主要优点:

e0d5e06336eb25aac1be74dfdf4a6214.png

1)代码变,文档变。只需要少量的注解,Swagger 就可以根据代码自动生成 API 文档,很好的保证了文档的时效性。


2)跨语言性,支持 40 多种语言。


3)提供交互式的UI,我们可以直接在文档页面调试 API,省去了准备复杂的调试参数的过程。


4)还可以将文档导入到自动化测试工具中,快速生成测试报告。

3、Swagger工作流程

Swagger接口生成工作流程:

19a1a4fbbd6c9fbfa267d47179ae0279.png

1、系统启动时,扫描Swagger的配置类


2、在此类中指定来要扫描的包路径,找到在此包下及子包下标记@RestController注解的Controller类。还可以通过以下这些注解来灵活配置一些参数。


比如:配置发送错误返回的信息 @ApiError ,配置一个或者多个请求参数,@ApiImplicitParam、@ApiImplicitParams等等。


3、根据Controller类中的Swagger注解生成接口文档,启动项目,访问项目虚拟路径/swagger-ui,查看生成的文档内容。


以上就是对Swagger工作流程的理解。


我是被编程耽误的文艺Tom,关注我,面试不再难!


完整版面试资料和答案以及PDF文档 :

9106b97c16b34d06af118b23d081cde9.gif

目录
打赏
0
0
1
0
52
分享
相关文章
集成Swagger 学习(二)
集成Swagger 学习(二)
122 0
|
10月前
|
Swagger问题:我希望我的Swagger在生产的时候使用,在发布的时候不使用
Swagger问题:我希望我的Swagger在生产的时候使用,在发布的时候不使用
94 0
比Swagger更好用的工具
比Swagger更好用的工具
283 2
比Swagger更好用的工具
接口测试、管理神器-Swagger
接口测试、管理神器-Swagger
400 0
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等