目錄
一、Yapi 簡介
1、Yapi是什么？
Yapi 由 YMFE開源，旨在為開發、產品、測試人員提供更優雅的接口管理服務，可以幫助開發者輕松創建、發布、維護API。
YAPI 是由去哪兒網移動架構組(簡稱YMFE，一群由FE、iOS和Android工程師共同組成的最具想象力、創造力和影響力的大前端團隊)開發的可視化接口管理工具，是一個可本地部署的、打通前后端及QA的接口管理平台。有了YAPI，我們可以很方便的測試、管理和維護多個項目的API接口，YAPI是一個獨立的服務平台。
2、Yapi的主要功能簡介
權限管理：YApi 成熟的團隊管理扁平化項目權限配置滿足各類企業的需求
可視化接口管理：基於 websocket的多人協作接口編輯功能和類 postman 測試工具，讓多人協作成倍提升開發效率
Mock Server：易用的 Mock Server，再也不用擔心 mock 數據的生成了
自動化測試：完善的接口自動化測試，保證數據的正確性
數據導入：支持導入swagger，postman，har，json數據格式，方便遷移舊項目
插件機制：強大的插件機制，滿足各類業務需求
Yapi支持內網部署：只需在管理員或內網某台機器上安裝部署一次，團隊其他成員不需要部署，訪問相應的地址即可使用。
二、Yapi 安裝環境
系統：Windows10
安裝環境：node環境+mongodb數據庫（yapi系統需要部署在node環境中，且使用mongodb進行數據庫存儲。）
安裝包版本：
Node：v12.18.3
npm：6.14.8（Node Package Manager，Node包管理工具）
MongoDB：v4.2.17
Yapi：1.9.2
以上是本文的安裝包版本，建議按照以上版本使用，以免出現其他報錯，影響正常安裝。
三、Yapi安裝步驟
1、Node及npm安裝
Node下載地址：
Node安裝：根據自己的系統版本下載.msi安裝包，下載完成后點擊安裝，然后直接next就好。
注意：
- 遇到該勾選的勾選了就行
- 安裝過程中記得將nodejs添加至環境路徑
- 安裝路徑的話默認就好
- 安裝完成后，在命令行輸入path，查看node.js是否已被添加至系統環境變量
node及npm版本查看命令：
// 命令輸入環境：Windows系統下的 cmd 命令窗口
node -v // 查看node當前安裝版本
npm -v //查看npm當前安裝版本npm升級及安裝指定版本命令：
// 命令輸入環境：Windows系統下的 cmd 命令窗口
npm install -g npm // 安裝最新版本
npm -g install npm@6.14.8 // 安裝指定版本Node及npm版本查看截圖：
2、MongoDB安裝
MongoDB下載地址：
MongoDB安裝：下載需要的.msi文件后，雙擊進入安裝界面，直接都點擊下一步好了。
MongoDB默認安裝目錄：C:\Program Files\MongoDB\Server\4.2
MongoDB目錄結構截圖：
MongoDB配置文件：mongod.cfg
注意：沒有的話可以自己創建一個mongod.cfg文件，使用notepadd++編輯器編輯。
# mongod.conf
# for documentation of all options, see:
# http://docs.mongodb.org/manual/reference/configuration-options/
# Where and how to store data.
storage:
dbPath: C:\Program Files\MongoDB\Server\4.2\data
journal:
enabled: true
# engine:
# mmapv1:
# wiredTiger:
# where to write logging data.
systemLog:
destination: file
logAppend: true
path: C:\Program Files\MongoDB\Server\4.2\log\mongod.log
# network interfaces
net:
port: 27017
bindIp: 127.0.0.1MongoDB環境變量配置：右擊我的電腦>屬性>高級系統設置>系統屬性-高級-環境變量>系統變量-Path>新建：輸入MongoDB安裝bin目錄路徑即可。
如：C:\Program Files\MongoDB\Server\4.2\bin
MongoDB版本查看命令：
打開MongoDB安裝bin目錄，並在目錄路徑中輸入cmd，打開命令窗口（這樣打開就直接在改路徑下了，就不需要再次通過cd切換到MongoDB安裝bin目錄了）
// 命令輸入環境：Windows系統下的 cmd 命令窗口
mongo --version // 查看MongoDB當前安裝版本MongoDB啟動命令：
// 命令輸入環境：Windows系統下的 cmd 命令窗口
net start mongodb // MongoDB服務啟動命令
MongoDB 數據庫連接命令：
// 命令輸入環境：Windows系統下的 cmd 命令窗口
mongo // 連接數據庫
show databases // 查詢數據庫
exit // 退出數據庫連接
至此 MongoDB數據庫已經准備就緒了！可以進行下一步操作了——安裝Yapi。
3、Yapi安裝
Yapi倉庫地址：
Yapi內網部署介紹：
這里介紹方式一：執行 yapi server 啟動可視化部署程序部署
npm安裝Yapi命令：
// 命令輸入環境：Windows系統下的 cmd 命令窗口
npm install -g yapi-cli --registry https://registry.npm.taobao.org // 在線安裝Yapi啟動Yapi服務命令：
// 命令輸入環境：Windows系統下的 cmd 命令窗口
yapi server // 啟動Yapi服務
瀏覽器打開：，進入yapi的配置安裝服務。
注意：
- 選擇需要安裝的版本，最好用本文章提供的版本，以免出現其他報錯
- 填寫好公司的名稱，可以自定義
- 填寫好管理員郵箱，也可以不填默認為admin@admin.com（后面可以配置）
- 記住Yapi安裝路徑，如：C:\Users\Administrator\my-yapi
填寫好以上內容后，點擊“開始部署”按鈕，進行部署；部署成功后，就是node啟動yapi服務啦。
Yapi的目錄結構圖：
node啟動Yapi服務：
在yapi安裝目錄中輸入cmd，打開命令行窗口，輸入啟動yapi服務命令：
node vendors/server/app.js // 啟動yapi服務瀏覽器訪問 http://localhost:3000 或
賬號名：你設置的郵箱，初次管理員登錄密碼為：ymfe.org
至此 Windows系統下 Yapi 安裝全部結束了！
如果你安裝中有問題可以問百度
最后，局域網內部yapi使用：同一局域網下的同伴可以使用你的ip地址加上端口號即可進行訪問。
// 命令輸入環境：Windows系統下的 cmd 命令窗口
ipconfig // 查看你自己的ip，一般為192.168.0.x
// 則瀏覽器中輸入 192.168.0.x:3000 即可訪問到yapi系統主頁了。本地啟動Yapi服務步驟：
1）進入MongoDB安裝bin目錄，cmd打開第一個命令行窗口
——啟動MongoDB數據庫：net start mongodb
2）同命令行窗口輸入命令：yapi server，啟動 yapi部署環境服務
3）進入yapi安裝目錄my-yapi，cmd打開第二個命令行窗口
——啟動yapi：node vendors/server/app.js
4）打開瀏覽器，輸入：，登錄即可訪問主頁。
本地啟動Yapi服務截圖：
四、Yapi使用簡介
Yapi使用教程地址：
此處不再贅述。
