怎么搭建一个Yapi环境

发布时间：2021-06-22 17:28:29 作者：Leah
来源：亿速云阅读：223

# 怎么搭建一个Yapi环境

## 一、Yapi简介

Yapi是由去哪儿网前端团队开源的一款高效、易用、功能强大的API管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。它具有以下核心特性：

- 可视化接口管理
- Mock服务支持
- 自动化测试
- 权限管理
- 数据统计分析
- 支持Swagger/OpenAPI规范导入

## 二、环境准备

### 1. 系统要求
- 操作系统：Linux/Windows/macOS（推荐Linux服务器）
- Node.js：v12+（推荐v14/v16 LTS版本）
- MongoDB：v3.6+
- Git客户端

### 2. 软件安装

#### 安装Node.js（以Ubuntu为例）
```bash
curl -sL https://deb.nodesource.com/setup_16.x | sudo -E bash -
sudo apt-get install -y nodejs

安装MongoDB（社区版）

# Ubuntu安装示例
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 656408E390CFB1F5
echo "deb [ arch=amd64 ] https://repo.mongodb.org/apt/ubuntu bionic/mongodb-org/4.4 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-4.4.list
sudo apt update
sudo apt install -y mongodb-org
sudo systemctl start mongod
sudo systemctl enable mongod

三、Yapi安装部署

1. 通过可视化安装（推荐新手）

# 安装yapi-cli工具
npm install -g yapi-cli --registry https://registry.npm.taobao.org

# 启动安装向导
yapi server

安装向导会提示： 1. 访问 http://localhost:9090 进入安装页面 2. 配置MongoDB连接信息（默认localhost:27017） 3. 设置管理员邮箱和密码 4. 选择部署路径

2. 手动安装方式

# 克隆仓库
git clone https://github.com/YMFE/yapi.git
cd yapi

# 安装依赖
npm install --production --registry https://registry.npm.taobao.org

# 初始化数据库
npm run install-server

# 启动服务
node server/app.js

四、配置优化

1. 生产环境配置

修改config.json文件（位于项目目录）：

{
  "port": "3000",
  "adminAccount": "admin@yourdomain.com",
  "db": {
    "servername": "127.0.0.1",
    "DATABASE": "yapi",
    "port": 27017,
    "user": "",
    "pass": "",
    "authSource": ""
  },
  "mail": {
    "enable": true,
    "host": "smtp.163.com",
    "port": 465,
    "from": "***@163.com",
    "auth": {
      "user": "***@163.com",
      "pass": "*****"
    }
  }
}

2. Nginx反向代理配置

server {
    listen 80;
    server_name api.yourdomain.com;
    
    location / {
        proxy_pass http://127.0.0.1:3000;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
    }
}

五、服务管理

1. 使用pm2进程管理

npm install pm2 -g
pm2 start "node server/app.js" --name yapi
pm2 save
pm2 startup

2. 常用命令

启动服务：pm2 start yapi
停止服务：pm2 stop yapi
查看日志：pm2 logs yapi
重启服务：pm2 restart yapi

六、数据备份与恢复

1. MongoDB备份

mongodump -h 127.0.0.1 -d yapi -o /backup/yapi-$(date +%Y%m%d)

2. 恢复数据

mongorestore -h 127.0.0.1 -d yapi /backup/yapi-20230101/yapi

七、常见问题解决

1. 安装时卡住或报错

解决方案：切换npm源为淘宝镜像


npm config set registry https://registry.npm.taobao.org

2. 无法连接MongoDB

检查项：
- MongoDB服务是否启动
- 是否开启认证（需在config.json配置auth）
- 防火墙是否开放27017端口

3. 邮件服务配置失败

测试命令：


curl -X POST http://localhost:3000/api/user/reg \
-H "Content-Type: application/json" \
-d '{"email":"test@test.com","password":"123456"}'

八、升级Yapi版本

# 停止服务
pm2 stop yapi

# 备份数据
mongodump -h 127.0.0.1 -d yapi -o /backup/yapi-before-upgrade

# 获取最新代码
cd yapi
git pull origin master

# 更新依赖
npm install --production

# 检查并升级数据库
npm run upgrade

# 重启服务
pm2 start yapi

九、最佳实践建议

权限管理：
- 合理分配项目成员角色（开发者、管理员、只读用户）
- 使用分组管理不同部门的API
接口规范：
- 制定统一的接口命名规范
- 充分利用分类和标签功能
自动化：
- 配置Webhook与CI/CD系统集成
- 利用自动化测试功能
数据安全：
- 定期备份MongoDB数据
- 配置HTTPS访问

十、总结

通过本文的详细步骤，您应该已经成功搭建了Yapi环境。Yapi作为一款优秀的API管理工具，能够显著提升团队的接口协作效率。建议进一步探索： - 接口Mock功能的使用 - 自动化测试场景配置 - 与Swagger的集成方案 - 自定义插件的开发

遇到问题时，可以参考Yapi官方文档或GitHub Issues区寻求解决方案。 “`

（注：实际字数约1600字，可根据需要扩展具体章节内容）