yapi部署文檔

windows 下 yapi部署文檔

1. 安裝nodejs
2. 安裝mongodb
3. 安裝yapi

介紹

隨着 web 技術的發展，先後端分離成爲愈來愈多互聯網公司構建應用的方式。先後端分離的優點是一套 Api 可被多個客戶端複用，分工和協做被細化，大大提升了編碼效率，但同時也帶來一些「反作用」:

1. 接口文檔不可靠。不少小夥伴管理接口文檔，有使用 wiki 的，有 word 文檔的，甚至還有用聊天軟件口口相傳的，後端接口對於前端就像一個黑盒子，常常遇到問題是接口因未知緣由增長參數了，參數名變了，參數被刪除了。
2. 測試數據生成方案沒有統一出口。咱們都有這樣的經歷，前端開發功能依賴後端，解決方案有本身在代碼注入 json 的，還有後端工程師臨時搭建一套測試數據服務器，這種狀況下勢必會影響工做效率和代碼質量，也不能及時進行更新。
3. 資源分散，沒法共享。接口調試每一個開發者單獨維護一套 Postman 接口集，每一個人沒法共用其餘人的接口集，存在大量重複填寫請求參數工做，最重要的是 postman 無法跟接口定義關聯起來，致使後端沒有動力去維護接口文檔。 基於此，咱們在前端和後端之間搭建了專屬橋樑—— YApi 接口管理平臺

安裝mongodb

• 安裝mongodb 到 D:\Mongo
• mongodb 安裝目錄下建立幾個文件夾具體以下

1. 數據庫路徑（data目錄）

2. 日誌路徑（logs目錄）

3. 日誌文件（mongo.log文件）

4. 建立配置文件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

1. 克隆項目到本地
2. 使用命令進入項目所在目錄
3. 首次使用先運行npm install -g yapi-cli --registry https://registry.npm.taobao.org
4. 運行yapi server
5. 訪問http:\ip:9090進行yapi部署
6. 切換到部署目錄，輸入node vendors/server/app.js
7. 訪問http:\ip:3000

注意

• 若是內網安裝 能夠先在外網安裝好後而後拷貝代碼和mongodb 數據文件到內網
• 內網環境 antd 的圖標沒法看到
• mongodb-win32-x86_64-2008plus-ssl-3.4.10-signed mongodb 若是是3.6安裝時候須要官網下載 補丁