关于前端:在线等后端悄悄改了接口文档被我抓住了怎么办

47次阅读

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

不晓得各位有没有经验过这种状况,前后端磋商好接口后,约定好了字段,忽然有一天,后端轻轻改了接口文档,没有及时告诉前端,等测试测出 bug 之后,框,一口大锅甩在你头上。Bug 数量 +1

当你去找后端问啥时候批改了,怎么不告诉一声,后端大佬说,没有批改啊,不信你去看看文档,我都是依照文档实现的;当然啦,这是极少数的状况,大多数都是后端老哥改了忘了告诉你而已

于是我给 @clean-js/api-gen 增加了 diff 性能,记录每次文档变更,无论减少,删除,批改接口文档,都会记录下来;不理解 @clean-js/api-gen 是啥的,能够看看之前的文章, 开释生产力 | Yapi,swagger2,swagger3 生成申请代码

diff 性能

接下来用 YAPI 在线文档演示一下,除了用 YAPI,应用 swagger2/ 3 也都一样能够 diff

目前有两个接口

运行 api-gen, 生成的代码如下

接下来咱们新增一个接口, 从新运行 api-gen

在控制台会提醒你有局部 APIs 产生了扭转

之后会生成一个 log 文件夹,外面依照日期生成 log,具体内如下,新增一个接口,method 为 GET,path 为 /api/jym/test

同理,删除变更也会记录。比照的都是上一次的文档

接下来咱们试试变更接口文档,这个是原来的 /api/user/{id} 接口返回的字段

咱们批改第一个 field_1 为 jym

而后从新运行 api-gen,log 日志会把变更的接口以及变更前后的 json 都记录下来
Parameters Change in response get /api/user/{id}

这样咱们就能够晓得哪些接口产生了变动,倡议时不时运行一下 api-gen,省得接口扭转了都不晓得

那么问题来了,要是你抓到了后端轻轻改文档,你会怎么办呢?


这个版本除了减少 diff 性能,还优化了编译速度,开启多过程编译,有趣味的小伙伴能够在评论区留言,人数多的话下次讲讲 node 如何开启多过程,晋升性能


不容易呀,终于有人 star 了😭,非常感谢这位帅哥美女

贴上源码 👉🏻 @clean-js/api-gen

期待宝子们的 star⭐️,你的反对就是我最大的能源

正文完
 0