不晓得各位有没有经验过这种状况,前后端磋商好接口后,约定好了字段,忽然有一天,后端轻轻改了接口文档,没有及时告诉前端,等测试测出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⭐️,你的反对就是我最大的能源