YApi 官方文檔介紹了可視化部署和命令行部署兩種私有化部署方式,下面在官方文檔的基礎上介紹第二種部署方法。
環境準備
要求有 Node(7.6+)、MongoDB(2.6+)、Git。這裏只介紹 MongoDB 的安裝。
-
到 download/community 下載 MongoDB,我下載的是 7.0.1 版。
-
安裝 MongoDB(見如何在 Windows 上下載和安裝 MongoDB)
-
在瀏覽器輸入 http://localhost:27017 測試是否啓動了服務,顯示
lt looks like you are trying to access MongoDB...
說明已啓動 -
將 MongoDB 加入 Path 環境變量,參考 Windows 下 MongoDB 配置環境變量(win11 最新教程)
-
下載 MongoDB Shell(我下載的是 1.10.6 版),解壓並運行
mongosh.exe
,初次進入後回車,之後執行如下命令:use yapi // 創建一個名爲 yapi 的數據庫 db.createUser({ user: 'yapi', pwd: '123456', roles: [{ role: 'readWrite', db: 'yapi' }] }) // 創建用戶,後面搭建時用到 db.auth('yapi', '123456') // 驗證新用戶是否可以訪問數據庫
部署
執行如下命令:
md yapi
cd yapi
git clone --depth=1 https://github.com/YMFE/yapi.git vendors
copy vendors\config_example.json .\config.json // 複製完成後分別修改其中的用戶名和密碼爲 yapi 和 123456,並按個人情況修改其他內容
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 配置的端口} 測試是否正常