昨天的文章，說明了筆者為何要推薦 YApi 這個平台。

既然是個平台，就得經過安裝才能使用！
YApi 的安裝，可以說是非常的簡單無痛，
平台相依非常少，遷移簡單，這也是我喜歡它的原因。

YApi 環境要求

• nodejs（7.6+)
• mongodb（2.6+）
• git

YApi 使用 mongodb 作為平台的資料庫，
在設計上考慮到備份的需求，平台並不會產生中繼資料。
在平台備份或遷移時，只需要備份 mongodb 的資料。
換主機後，匯入 mongodb 就可以重建服務的 API SPEC、Mock Data、自動化測試。

• YApi
  https://github.com/YMFE/yapi

安裝

npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server

服務管理

可以使用 pm2 來啟動 YApi 服務

npm install pm2 -g  //安裝pm2
cd  {項目目錄}
pm2 start "vendors/server/app.js" --name yapi //pm2管理yapi服務
pm2 info yapi //查看服務信息
pm2 stop yapi //停止服務
pm2 restart yapi //重啟服務

升級

升級版本非常容易，且不會影響已有的資料，只會同步 vendors 目錄下的原始碼。

cd  {項目目錄}
yapi ls //查看版本號列表
yapi update //更新到最新版本
yapi update -v {Version} //更新到指定版本

以上是 YApi 官網的安裝方式，但我更喜歡的是使用 Docker 安裝

• docker-YApi
  https://github.com/fjc0k/docker-YApi

git clone https://github.com/fjc0k/docker-YApi.git

先修改 config.js 文件中的 adminAccount，這是 Super Admin 的 email

docker-compose up -d

然後，通過 http://localhost:40001 即可訪問 YApi。

預設 Admin 帳號是 config.js 中 adminAccount 的 email，密碼是 ymfe.org，登入後可以先修改密碼

如何重啟

若你修改了配置文件 config.js，務必重啟應用才能生效：

docker-compose restart yapi-web

如何升級

docker-compose pull yapi-web \
  && docker-compose down \
  && docker-compose up -d

查看 Log

docker-compose logs yapi-web

如果使用 docker-YApi 安裝 YApi，遷移到新機器就更簡單了

只要將整個資料夾 Copy 到有安裝 Docker 的新主機，

然後！

docker-compose up -d

就可以將整個 YApi 服務完美遷移到新主機