谈谈你对Swagger工作流程的理解？

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

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

1、Swagger简介

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

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

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

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

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

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

2、为什么要使用 Swagger

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

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

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

2）跨语言性，支持 40 多种语言。

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

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

3、Swagger工作流程

Swagger接口生成工作流程：

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

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

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

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

文章名称：谈谈你对Swagger工作流程的理解？
文章来源：http://www.shufengxianlan.com/qtweb/news19/438019.html

网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联