windows 下 yapi部署文檔
- 安裝nodejs
- 安裝mongodb
- 安裝yapi
介紹
隨着 web 技術的發展,前后端分離成為越來越多互聯網公司構建應用的方式。前后端分離的優勢是一套 Api 可被多個客戶端復用,分工和協作被細化,大大提高了編碼效率,但同時也帶來一些“副作用”:
- 接口文檔不可靠。很多小伙伴管理接口文檔,有使用 wiki 的,有 word 文檔的,甚至還有用聊天軟件口口相傳的,后端接口對於前端就像一個黑盒子,經常遇到問題是接口因未知原因增加參數了,參數名變了,參數被刪除了。
- 測試數據生成方案沒有統一出口。我們都有這樣的經歷,前端開發功能依賴后端,解決方案有自己在代碼注入 json 的,還有后端工程師臨時搭建一套測試數據服務器,這種情況下勢必會影響工作效率和代碼質量,也不能及時進行更新。
- 資源分散,無法共享。接口調試每個開發者單獨維護一套 Postman 接口集,每個人無法共用其他人的接口集,存在大量重復填寫請求參數工作,最重要的是 postman 沒法跟接口定義關聯起來,導致后端沒有動力去維護接口文檔。 基於此,我們在前端和后端之間搭建了專屬橋梁—— YApi 接口管理平台
安裝mongodb
- 安裝mongodb 到 D:\Mongo
- mongodb 安裝目錄下創建幾個文件夾具體如下
-
數據庫路徑(data目錄)
-
日志路徑(logs目錄)
-
日志文件(mongo.log文件)
-
創建配置文件mongo.conf,文件內容如下:路徑修改為對應路徑
#數據庫路徑
dbpath=D:\Mongo\data
#日志輸出文件路徑
logpath=D:\Mongo\logs\mongo.log
#錯誤日志采用追加模式
logappend=true
#啟用日志文件,默認啟用
journal=true
#這個選項可以過濾掉一些無用的日志信息,若需要調試使用請設置為false
quiet=true
#端口號 默認為27017
port=27017
5) 創建並啟動MongoDB服務,執行下面命令
mongod --config "D:\Mongo\mongo.conf" --install --serviceName "MongoDB"
net start MongoDB
安裝yapi
- 克隆項目到本地
- 使用命令進入項目所在目錄
- 首次使用先運行npm install -g yapi-cli --registry https://registry.npm.taobao.org
- 運行yapi server
- 訪問http:\ip:9090進行yapi部署
- 切換到部署目錄,輸入node vendors/server/app.js
- 訪問http:\ip:3000
注意
- 如果內網安裝 可以先在外網安裝好后然后拷貝代碼和mongodb 數據文件到內網
- 內網環境 antd 的圖標無法看到
- mongodb-win32-x86_64-2008plus-ssl-3.4.10-signed mongodb 如果是3.6安裝時候需要官網下載 補丁