Yapi本地搭建及错误解决
YAPI介绍
YAPI是一款开源的接口管理平台，支持项目管理、接口管理、接口Mock、接口测试等，简单易用且界面美观。
YAPI 本地安装
安装 Mongo并启动
Mac安装MongoDB
sudo chown -R "$USER":admin /usr/local
brew tap mongodb/brew
brew install mongodb-community
Windows安装MongoDB
参考: https://www.runoob.com/mongodb/mongodb-window-install.html
Linux安装MongoDB
参考：https://www.runoob.com/mongodb/mongodb-linux-install.html
安装Nodejs
Mac安装Nodejs
brew install node
其他系统可以参考：Nodejs官方下周链接
配置国内源
npm install -g cnpm --registry=https://registry.npm.taobao.org
安装yapi-cli
npm install -g yapi-cli
启动YAPI服务
yapi server
YAPI Docker安装
- 拉取MongoDB镜像
docker run -d --name mongo-yapi mongo
- 拉取YAPI镜像
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi
- 启动MongoDB并初始化YAPI数据库
docker run -it --rm \
--link mongo-yapi:mongo \
--entrypoint npm \
--workdir /api/vendors \
registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
run install-server
- 启动YAPI服务
docker run -d \
--name yapi \
--link mongo-yapi:mongo \
--workdir /api/vendors \
-p 3000:3000 \
registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
server/app.js
YAPI使用
访问网站
http://127.0.0.1:3000/ 使用账号 密码登录即可
Docker部署 默认 登录账号 admin@admin.com，密码 ymfe.org
接口请求插件安装
- 点击[点击下载]连接，解压下载的crossRequest.zip得到cross-request.crx
- 修改cross-request.crx后缀名为.rar，解压后得到cross-request目录
- 浏览器打开chrome://extensions/，打开开发者模式，点击 加载已解压的扩展程序，选择cross-request目录即可
常见问题
【yapi-cli安装】初始化数据库报错
Error: (node:90198) DeprecationWarning: current Server Discovery and Monitoring engine is deprecated, and will be removed in a future version. To use the new Server Discover and Monitoring engine, pass option { useUnifiedTopology: true } to the MongoClient constructor.
解决方法
cd ~/my-yapi/vendors
vim exts/server/utils.js 22行 添加 useUnifiedTopology: true
let options = {useNewUrlParser: true, useCreateIndex: true, useUnifiedTopology: true};
启动服务
cd ~/my-yapi
node vendors/server/app.js
参考官网的命令行部署方式 https://hellosean1025.github.io/yapi/devops/index.html
npm run install-server
【yapi-cli安装】初始化管理员账号失败
解决方法：删除mongodb数据库中已创建的管理员数据，重新运行
Mac OS可以使用 NoSQL Booster客户端连接Mongodb，如下图：
初始化管理员账号成功,账号名："superhin@126.com"，密码："ymfe.org"
【yapi-cli安装】界面点击安装报错
node建议为15以下，这里改为使用10.24.1
brew install nvm
vim ~/.zshrc 添加
export NVM_DIR="$HOME/.nvm"
[ -s "/usr/local/opt/nvm/nvm.sh" ] && \. "/usr/local/opt/nvm/nvm.sh" # This loads nvm
[ -s "/usr/local/opt/nvm/etc/bash_completion.d/nvm" ] && \. "/usr/local/opt/nvm/etc/bash_completion.d/nvm" # This loads nvm bash_completion
使配置生效
source ~/.zshrc
使用nvm安装node10
nvm install 10
nvm use 10.24.1
node -v
【本地克隆安装】node-gyp rebuild失败找不到python命令
brew install pyenv
pyenv install 3.9.6
pyenv global 3.9.6
vim ~/.zshrc， 添加
if command -v pyenv 1>/dev/null 2>&1; then
eval "$(pyenv init -)"
fi
使配置生效
source ~/.zshrc
【yapi-cli安装】yapi server启动后节目安装时报错 找不到 yapi.demo.qunar.com
Error: getaddrinfo ENOTFOUND yapi.demo.qunar.com yapi.demo.qunar.com:80
找到npm全局包路径
npm config get prefix
/Users/superhin/.nvm/versions/node/v14.21.3
进入yapi-cli目录
cd /Users/superhin/.nvm/versions/node/v14.21.3/lib/yapi-cli
修改server.js
vim src/commands/server.js
注释调日志上报部分如下图：
