Yapi 部署二次開發常見問題

• 2019 年 10 月 11 日
• 筆記

Yapi 作為目前業內最好用的介面管理平台， 旨在為開發、產品、測試人員提供更優雅的介面管理服務，可以幫助開發者輕鬆創建、發布、維護 API。

1、命令行部署

如果 github 壓縮文件無法下載，或需要部署到一些特殊的伺服器，可嘗試此方法

mkdir yapi  cd yapi  git clone https://github.com/YMFE/yapi.git vendors //或者下載 zip 包解壓到 vendors 目錄（clone 整個倉庫大概 140+ M，可以通過 `git clone --depth=1 https://github.com/YMFE/yapi.git vendors` 命令減少，大概 10+ M）  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、如果MongoDB沒有設置密碼可以刪除config.json中的auth和pass配置。

2、初始化完成後會生成init.lock文件，如果需要重新初始化，可以刪除此文件。

常見問題

1、MongoDB連接失敗

錯誤資訊：MongoError: failed to connect to server [192.168.10.5:27017] on first connect

MongoDB服務沒起，或者config.json中參數配置不正確

2、初始化失敗

錯誤資訊：UnhandledPromiseRejectionWarning: Error: 初始化管理員帳號

init.lock文件被刪除了，導致yapi再初始化時DB中已經存在這個賬戶資訊，所有報錯，可以把DB中該賬戶資訊刪除，或者修改配置文件中的初始帳號。

3、ykit 打包命令找不到

npm install ykit -g安裝ykit命令

4、ydoc 構建文檔命令找不到

npm install -g ydoc 安裝ydoc命令 執行 ydoc build 重新構建生成文檔

5、不支援long類型數據

默認的js不支援long類型，導致傳入long類型時可能導致介面錯誤。

6、Yapi項目拉取失敗

可以使用中國鏡像地址：https://gitee.com/mirrors/YApi.git，一天同步一次。