Yapi 可视化接口平台安装实践

时间:2022-07-24
本文章向大家介绍Yapi 可视化接口平台安装实践,主要内容包括其使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。

环境要求

  • nodejs(7.6+)
  • mongodb(2.6+)
  • git

安装

使用我们提供的 yapi-cli 工具,部署 YApi 平台是非常容易的。执行 yapi server 启动可视化部署程序,输入相应的配置和点击开始部署,就能完成整个网站的部署。部署完成之后,可按照提示信息,执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定url, 点击登录输入您刚才设置的管理员邮箱,默认密码为 ymfe.org 登录系统(默认密码可在个人中心修改)。

npm install -g yapi-cli --registry <https://registry.npm.taobao.org>
yapi server 

https://gitee.com/zxxfire/blogImags/raw/master/img/20200804113030.png

yapi 命令无效你需要做个链接

https://gitee.com/zxxfire/blogImags/raw/master/img/20200804113341.png

https://gitee.com/zxxfire/blogImags/raw/master/img/20200804114209.png

根据提示填写相应内容

https://gitee.com/zxxfire/blogImags/raw/master/img/20200804144714.png

OK部署成功,安装下 PM2 管理服务

https://gitee.com/zxxfire/blogImags/raw/master/img/20200804145332.png

npm install pm2 -g  //安装pm2
cd  {项目目录}
pm2 命令不起效记得做下链接
pm2 start "vendors/server/app.js" --name yapi //pm2管理yapi服务
pm2 info yapi //查看服务信息
pm2 stop yapi //停止服务
pm2 restart yapi //重启服务

升级

升级项目版本是非常容易的,并且不会影响已有的项目数据,只会同步 vendors 目录下的源码文件。

cd  {项目目录}
yapi ls //查看版本号列表
yapi update //更新到最新版本
yapi update -v {Version} //更新到指定版本

IDEA 安装 easyYapi 插件

IDEA内可能无法打开插件市场可下载插件包后离线安装

选择需要上传的类或文件夹 alt+shift+e 上传接口