YApi 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理
Node.js 和 Git 的安装就不赘述了
一、安装 MongoDB 数据库
MongoDB数据库官网下载地址:https://www.mongodb.com/try/download/community?jmp=nav
-
下载. msi文件,双击运行,选择custom->next,不选install mongoDB compass,基本都是next
-
配置MongoDB,进入MongoDB安装目录的bin文件夹,复制文件夹路径后,将复制的路径新建在变量path中
-
在安装目录下\data\创建一个db目录,作为安装目录\data\的备用目录,显式指定该目录为存储位置
mongod.exe --dbpath D:\Program Files\MongoDB\Server\5.0\data\db mongod.exe --dbpath "你的MongoDB安装目录\data\db"
-
验证MongoDB是否部署成功
# 浏览器访问 http://localhost:27017/
-
要想连接成功必须要开服务mongod -dbpath "你的MongoDB安装目录\data\db 这条命令可要一直开着哦
二、将 YApi 源码下载到本地
Gitee的Yapi源码:https://gitee.com/mirrors/YApi
不管是使用 Git 克隆或者下载 .zip 押解到本地都可以
二、进入YApi文件夹,启用 YApi 服务
-
命令行进入 YApi 文件夹
-
在打开的命令行窗口输入以下命令,启动 YApi 服务
①
python npm install -g yapi-cli --registry https://registry.npm.taobao.org
② 通过npm get prefix 获取npm包的位置,然后切换到该目录
③ yapi server 替换本地端口即可访问:http://127.0.0.1:9090
④ 配置部署 YApi 服务信息
⑤ 启动服务,登陆系统- 通过提示文案,我们找到部署目录:C:\Users\PythonKimo\AppData\Roaming\npm\my-yapi\vendors
- 切换到部署目录,输入: “node vendors/server/app.js” 指令启动服务器
- 浏览器打开 http://127.0.0.1:3000 访问
- 初始化管理员账号名:admin@admin.com,密码:ymfe.org
三、使用pm2进行服务管理
如果使用 node vendors/server/app.js 启动Yapi服务的话,如果我们把cmd窗口关闭了,这时候我们就无法访问Yapi了,这时候我们就可以使用 pm2 管理 node 服务器启动、停止
-
安装 pm2
npm i -g pm2 --registry https://registry.npm.taobao.org
-
pm2管理yapi服务,进入Yapi的部署目录执行
pm2 start "vendors/server/app.js" --name yapi
-
pm2操作Yapi基本命令:
pm2 info yapi //查看服务信息 pm2 start yapi //停止服务 pm2 stop yapi //停止服务 pm2 restart yapi //重启服务