Yapi部署说明

1.环境搭建

确保 node 版本=> 7.6,请运行 node -v 查看版本号
确保 mongodb 版本 => 2.6，请运行 mongo --version 查看版本号
确保安装了 npm, 运行 npm -v 查看版本号(高点版本node一般自带)
确保安装了 git,运行 git --version 查看版本号(确保git版本最新，不然会报错:由于GitHub 不再支持TLSv1/TLSv1.1了)

猛戳了解

• Window 上安装Node.js
• Windows 平台安装 MongoDB
• Git 安装配置

2.部署

这里将采用官网的第二种命令行方式进行部署

mkdir yapi
cd yapi
git clone https://github.com/YMFE/yapi.git vendors //或者下载 zip 包解压到 vendors 目录
cp vendors/config_example.json ./config.json //复制完成后请修改相关配置
cd vendors
npm install --production --registry https://registry.npm.taobao.org
npm run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
node server/app.js //启动服务器后，请访问 127.0.0.1:{config.json配置的端口}，初次运行会有个编译的过程，请耐心等候

安装后的目录结构如下：

|-- config.json
|-- init.lock
|-- log
`-- vendors
    |-- CHANGELOG.md
    |-- LICENSE
    |-- README.md
    |-- client
    |-- common
    |-- config_example.json
    |-- doc
    |-- exts
    |-- nodemon.json
    |-- npm-debug.log
    |-- package.json
    |-- plugin.json
    |-- server
    |-- static
    |-- test
    |-- webpack.alias.js
    |-- yapi-base-flow.jpg
    |-- ydocfile.js
    `-- ykit.config.js

注意：如果在初始化数据库认证失败时，请确保下面几点：

1.config.json配置文件中数据库、用户名和密码的正确性

"db": {
"servername": "127.0.0.1",
"DATABASE": "yapi",
"port": 27017,
"user": "myuser",
"pass": "123456",
"authSource": ""
},

2.配置中数据库对应的用户名是否存在和加以验证

db.createUser({user:'myuser',pwd:'123456',roles:[{role:'dbOwner',db:'yapi'}]})

db.auth('myuser','123456')

3.服务器管理

官网推荐使用 pm2 管理 node 服务器启动，停止，具体使用方法可参考下面的教程：

• 官网文档
• PM2实用入门指南

由于经常服务一停止，网站就挂了。为了永久守护这个yapi进程，这里要用到pm2。

安装

npm install pm2@latest -g

执行

切换到yapi的vendors目录 执行pm2 start

pm2 start server/app.js --watch

正常的话，应该能正常访问到，默认接口是3000,默认密码(ymfe.org) 登录系统（默认密码可在个人中心修改）