1.環境搭建
確保 node 版本=> 7.6,請運行 node -v 查看版本號
確保 mongodb 版本 => 2.6,請運行 mongo --version 查看版本號
確保安裝了 npm, 運行 npm -v 查看版本號(高點版本node一般自帶)
確保安裝了 git,運行 git --version 查看版本號(確保git版本最新,不然會報錯:由於GitHub 不再支持TLSv1/TLSv1.1了)
猛戳了解
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 服務器啟動,停止,具體使用方法可參考下面的教程:
由於經常服務一停止,網站就掛了。為了永久守護這個yapi進程,這里要用到pm2。
安裝
npm install pm2@latest -g
執行
切換到yapi的vendors目錄 執行pm2 start
pm2 start server/app.js --watch
正常的話,應該能正常訪問到,默認接口是3000,默認密碼(ymfe.org) 登錄系統(默認密碼可在個人中心修改)