需求来源
随着前端技术的发展,前后端分离的项目越来越多,把前端和后端分离和联系起来的就是API这个桥梁
后端提供
API前端利用
API同后端交互
我们常常数据交互这个模块分离开来(一个独立的模块或者各个模块独立的JS文件),此时作者就萌发了能不能自动生成一些代码来降低我们的工作量呢(好吧,实际上是以前我们做一个比较大的项目的时候需要一个人来专门的维护API部分)
我们用到的接口工具就是YAPI
❝Swagger也可以转化为
❞YAPI,迁移也是比较方便的,或者直接在撸一个
应运而生
这时候YAPI2JS应运而生,不说能节约很多的时间,但是可能节约一点点时间,让我们不必过多的关注API部分,更加的关注UI和交互
但是此时必须要小声哔哔一句
「后端只要文档写得好,前端接口肯定不挨标」
码云地址(GitHub有点卡)
https://gitee.com/debby-echo/YAP2JS
有同样兴趣可以一起聊聊实现哦
代码结构
运行
❝小声逼逼:记得改
❞app.ts中的一些参数用户名、密码、YAPI域名、PID等等
git clone https://gitee.com/debby-echo/YAP2JS
cd YAP2JS
npm install
npm run start
生成后的代码(可以根据自己需要自定义哦)
现在支持的和未来计划的
现在默认的生成的API文档都在src目录下
| 支持 | 完成状态 | 说明 |
|---|---|---|
| 生成方法名字 | 已完成 | url中/大于两个时取末尾两个,并且前缀加上请求类型, post /create/user example: postCreateUSer |
| 注释 - 方法用途 | 已完成 | 采用YAPI返回的title |
注释 - YAPI地址 |
已完成 | YAPI的接口地址 |
| 注释 - 请求参数 | 已完成 | API的请求参数(目前未考虑form-data,只考虑了application/json) |
「计划支持」
根据配置项对应目录生成对应的模块的JS-API文件