YApi 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。
这里我就来讲解本地部署 YApi
前提:
在部署 YApi 之前我们的本地服务器必须安装 nodejs,mongodb,git
node.js 安装可参考:vue.js 环境在 window 和 linux 安装
mongodb 安装可参考:windows 下安装 MongoDB
git 安装可参考:git 在 windows 下安装 git 服务器安装
一:下载 Yapi 源码
Yapi 源码地址:https://github.com/YMFE/yapi
如果 Yapi 源码地址下载较慢,可以选择码云的 Yapi 源码地址下载:https://gitee.com/mirrors/YApi
二:部署 Yapi
使用命令行进入下载下来的 Yapi 源码根目录
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server
如果执行上面的命令在浏览器访问,localhost:9090 无效果,执行:
npm install -g yapi-cli
yapi server
执行上面命令效果如下:
打开浏览器访问 localhost:9090,出现如下现象,按照提示进行部署
部署完成如下:
部署完成之后进入部署目录执行:
node vendors/server/app.js
在浏览器打开:localhost:3000
如下表示 Yapi 项目部署成功
三:使用 pm2 进行服务管理
如果使用 node vendors/server/app.js 启动 Yapi 服务的话,如果我们把 cmd 窗口关闭了,这时候我们就无法访问 Yapi 了,这时候我们就可以使用 pm2 管理 node 服务器启动,停止
1:安装 pm2
npm i -g pm2
2:pm2 管理 yapi 服务
进入 Yapi 的部署目录执行
pm2 start "vendors/server/app.js" --name yapi
如下表示成功:
这时候我们就可以使用 pm2 来管理 yapi 了
pm2 操作 Yapi 基本命令:
pm2 info yapi // 查看服务信息
pm2 start yapi // 停止服务
pm2 stop yapi // 停止服务
pm2 restart yapi // 重启服务