关于swagger:干掉丑陋的swagger堪称开发者的瑞士军刀

50次阅读

共计 2665 个字符,预计需要花费 7 分钟才能阅读完成。

动态的 Swagger 们跟不上频繁变更的代码

“为什么改了这个没通知我”,“理论性能和文档上说的不一样啊”。这些话大家做开发的想必耳朵都听出老茧了。真不是故意的,有时候工作比拟急,就先改了代码,想着当前再同步文档,而后就给忘了。我的项目更新又全靠社交软件告诉,人一多不免有一两个没及时沟通到的。的确给单干的小伙伴带来麻烦,但说实话开发也挺冤屈的。

这些问题产生的次要起因是,以后大部分研发团队的工作流程是这样的:

这种模式带来的问题是
1.Swagger,postman,MockJS 只能实现软件研发流程中某个环节的性能,造成实现接口设计,文档编写,调试,测试验证等工作须要应用好几个工具;
2. 更麻烦的是这些工具数据格式不互通,无奈相互导入,造成用 Swagger 定义和编写实现接口后,在 Postman,MockJS,Jmeter 等工具还要再去手动填写一遍能力开始工作,减少了无意义的工作量。
3. 沟通老本总是被忽略不计,但实际上不仅占据了很大工夫,各种沟通不及时、沟通不到位还十分让人心累。
4. 老板的需要来得急,老板的需要变得快,各种代码批改和变更难以及时告诉和同步到团队成员手中。

埋怨当然政治正确,但有啥用,该加的班还是要加。那么有什么方法能够解决这个问题吗?

有的

换个工具

低成本做长期主义的事件

我为大家提供的解决方案是一款国内的生产力工具 –Apifox

作为一款研发全流程,接口全周期的生产力工具,这款软件真正实现了数据流的买通,在一个软件上就能实现 接口设计 – 接口文档 – 接口调试 – 接口批改 – 接口 mock– 接口测试 – 接口自动化 – 接口迭代 的工作流闭环;
后端,前端,测试各个角色既能各取所需,又能协同单干。

Apifox 上的合作流程是这样的:

  1. 后端 在 Apifox可视化接口设计界面 上定义好 我的项目各个接口及对应参数 同时 编写接口文档阐明
  2. 前后端 一起评审,批改欠缺 接口 并在 同一界面 棘手更新 接口文档
  3. 后端 应用 接口调试 性能调试接口
  4. 前端 应用 零配置高仿真 mock性能对前端页面进行调试,无需手写 mock 规定
  5. 后端 应用 代码生成 性能间接生成 接口代码
  6. 测试 在接口治理页面一键生成 接口参数测试用例 , 并根据 业务场景 生成自动化测试用例,一键运行 接口用例并生成 接口测试报告 并分享给相干人员。
  7. 前后端 都开发完,前端从Mock 数据 切换到 正式数据,进行联调,因为应用同一个接口数据源,且遵循了接口标准,联调顺利
  8. 因为 bug 修复需要变更 ,接口产生了变动, 后端 批改 提交 后,前端 测试 实时同步 到了批改后的数据
  9. 项目经理 通过权限设置给 研发 , 产品 , 测试 , 内部单干人员 调配 编辑 , 只读 等各种操作权限,保护了我的项目平安
  10. 项目经理 通过各个接口的状态 开发中 , 测试中 , 已公布 来跟进我的项目的进度状况,把控项目风险。

Apifox 外围性能和界面是这样的:

36 氪报道过,Apifox 在 Pre- A 轮融资就失去了 3000 万元的融资。资本市场如此看好这个产品的发展潜力,是因为在经济增速变缓的现阶段,

对企业来说,它能通过进步整体的单干效率来 为企业节约老本
对研发人员来说,能够缩小无意义的工作量和繁冗耗时的沟通老本,将工夫花在能 晋升本身竞争力 的中央。

Apifox>Swagger+Postman+mockJS+Jmeter,它在传统软件的根底上做了不少操作优化和团队协同提效的性能。

Apifox 做的增速提效优化

1. 接口设计:从代码生成界面到可视化接口设计界面
Apifox 接口文档遵循 OpenApi 3.0 (原 Swagger)、JSON Schema 标准,可生成在线文档;零学习老本即可编写出合乎 RESTful 格调的接口文档,新人上手快;所见即所得,不易出错。

2. 文档保护:从接口与文档拆散到接口与文档合并
当你接手旧我的项目时,发现接口是上周的,接口文档是商周的,上手新我的项目全靠老司机口口相传,心田大略是解体的吧。
接口与文档拆散经常导致保护艰难。Apifox 的接口设计界面提供了 Markdown 格局的文档阐明区,批改完接口就如同 commit 代码时增加变更阐明般,自然而然地造成肌肉记忆。

3. 数据复用:从各自为政到定义一次、屡次复用
接口数据复用 :Swagger,Postman,MockJS,Jmeter 等软件彼此之间数据不互通,数据格式不统一,接口导入十分耗时麻烦。
而 Apifox 能身兼多职,包揽上述软件性能,在 Apifox 中定义一次接口,能被后端间接用来调试,前端间接用来 mock 界面,测试间接执行接口自动化。
数据模型复用 :可复用的数据结构,定义接口 返回数据结构 申请参数数据结构(仅 JSON 和 XML 模式)时可间接援用。

4. 同步更新,高效沟通: 从沟通滞后到数据变更即时同步
以后团队成员之间同步我的项目信息数据,仍旧依附着社交软件,低效、不及时,也容易漏掉某些成员。
Apifox 为此提供了同步性能,一旦接口数据有更新产生,就会即时同步更新并告诉到我的项目内所有成员。

5. 零配置 mock 高仿真数据: 从苦逼造数据到零配置 mock 实在数据
Apifox 依据接口定义里的数据结构、数据类型, 主动生成 mock 规定。
Apifox 内置智能 mock 规定库 ,依据字段名、字段数据类型,智能优化主动生成的 mock 规定。
用户还能够 自定义规定库,满足各种个性化需要。反对应用 正则表达式、通配符 来匹配字段名自定义 mock 规定。

除此之外

6. 旧有我的项目无痛迁徙
目前 Apifox 反对 OpenApi,Postman,Jmeter 等数据格式导入,不便旧有我的项目一键无痛迁徙到 Apifox,无需再次新建我的项目。

我的项目也反对以 html 或者 OpenApi,Markdown 格局导出,可用于 数据备份 单干人员查看

7.Apihub
内置企业微信凋谢 API,抖音凋谢 API 等第三方接口凋谢我的项目,接口能够间接在 Apifox 中调试,不须要到处找接口文档和手工填写接口。

同时 Apifox 也提供了网页版 Apihub,间接在网页端调试也齐全没问题。

8.Web 版本
除了客户端,还反对 web 版本,用户能够挪动办公,任意切换设施,适宜紧急加班这种状况。

9. 完全免费
这个软件 SaaS 版本官网曾经承诺永恒收费,只有私有化部署是付费的。而且 SaaS 版本 不限接口数量,不限我的项目人数,不限性能,十分厚道,对于日常开发来说,SaaS 版本曾经齐全够用了。

下载地址

介绍了 Apifox 这么多实用的性能,用上了才是真生产力!
如果小伙伴感觉好用,能够间接去他们的官网下载,复制上面的链接,粘贴到浏览器关上即可下载,或者点击 浏览原文 中转!
** 官网地址 **:www.apifox.cn

正文完
 0