yapi插件开发及安装的一些备注

yapi官方文档有些缺失,这里做一下补充,官方文档地址:https://hellosean1025.github.io/yapi/documents/redev.html

插件开发需要调试,这个需要先搭建二次开发环境,主要是拉取yapi源码下来,然后配置mongodb,安装依赖包,上面官方文档已经写得很清楚了,这里不做介绍。

1.为了使用yapi及ykit命令需要全局安装两个依赖包:npm install -g ykit ,npm install -g yapi-cli,安装完这两个包后才能顺利使用ykit进行打包和使用yapi命令进行插件安装(插件安装没法指定本地代码路径,需要联网,不太好用)。

2.yapi下载下来的源码有一个vendor/ext目录,这个目录的用途目前不知,要进行开发的插件源码应该放在vendor/node_module目录下,可以复制vendor/ext目录里面的一个插件到vendor/node_module文件夹下改为想要的名称,省去一些操作。

3.yapi插件server.js/controller.js里面的代码(服务端代码)在每次启动时都会立即生效,也就是对应的接口是立马可以访问的,但是client.js文件里面的代码并不会生效,所以在前端页面是看不到对应的效果的,要想在前端页面看到效果需要重新打包:ykit pack -m

4.yapi plugin yapi-plugin-xxxx这个插件安装命令做的就是下载代码到vendor/node_module目录下,然后执行ykit pack -m打包操作,所以要在生产环境安装自定义插件只需要将插件源码放到vendor/node_module目录下,然后执行重新打包即可,不是非得公开源码到npm库,贴一段源码。

yapi插件开发及安装的一些备注_第1张图片

5.yapi 项目源码有时可能出现npm run dev前端页面显示空白的问题,所以需要每次都先打包ykit pack -m,再用npm run start运行正式环境代码。

6.yapi运行时的输出是直接输出到控制台的,如果想输出到数据库的log中,需要额外配置,调试时直接输出到控制台即可。

7.yapi从mongodb中查出来的数据有点奇怪,看上去是对象,但是无法赋值,需要调用toObject方法将其转化为对象才能进行操作,这个问题困扰了很久,后面才搞明白的。egg:caseData =caseData.toObject();

 

 

 

 

 

你可能感兴趣的:(node.js)