https://yapi.fanruan.com/login
查看YApi源碼倉庫 https://github.com/YMFE/yapi
YApi源碼倉庫關於YApi的簡介
YApi 是高效、易用、功能強大的 api 管理平臺,旨在爲開發、產品、測試人員提供更優雅的接口管理服務。可以幫助開發者輕鬆創建、發佈、維護 API,YApi 還爲用戶提供了優秀的交互體驗,開發人員只需利用平臺提供的接口數據寫入工具以及簡單的點擊操作就可以實現接口的管理。
特性
- 基於 Json5 和 Mockjs 定義接口返回數據的結構和文檔,效率提升多倍
- 扁平化權限設計,即保證了大型企業級項目的管理,又保證了易用性
- 類似 postman 的接口調試
- 自動化測試, 支持對 Response 斷言
- MockServer 除支持普通的隨機 mock 外,還增加了 Mock 期望功能,根據設置的請求過濾規則,返回期望數據
- 支持 postman, har, swagger 數據導入
- 免費開源,內網部署,信息再也不怕泄露了
內網部署環境要求
- nodejs(7.6+)
- mongodb(2.6+)
- git
本文中Linux版本信息
查看Linux系統的版本信息:
cat /proc/version
查看Linux系統發行版信息:
cat /etc/redhat-release
安裝nodejs
進入nodejs的下載頁面,點擊如下圖箭頭指示的Linux 64-bit https://nodejs.org/en/download/
通過Xftp將下載的nodejs安裝包上傳到Linux
執行指令
chmod 777 ./node-v12.18.0-linux-x64.tar.xz
執行解包操作
tar -xvf node-v12.18.0-linux-x64.tar.xz
在環境變量中配置nodejs
vi /etc/profile
如下圖橢圓和箭頭標註的爲新添加的內容
執行如下指令,使環境變量立即生效
source /etc/profile
執行如下指令,查看安裝的版本號
node -v
npm -v
npm(Node Package Manager)是 node 的包管理器,它是隨着 nodejs 安裝時一起被安裝的。
下載和安裝mongodb
MongoDB是一個基於分佈式文件存儲的數據庫。由C++語言編寫。旨在爲WEB應用提供可擴展的高性能數據存儲解決方案。
如下圖,選擇社區版本
如下圖,設置Version、OS、package,然後執行Download操作
或者通過執行curl指令進行下載。-O:下載後保持其遠程文件的文件名 -#:進度條顯示當前的傳送狀態
curl -O -# https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-rhel70-4.2.7.tgz
下載完成時,如下圖:
執行如下指令,修改文件權限
chmod 777 mongodb-linux-x86_64-rhel70-4.2.7.tgz
執行解包操作
tar -zxvf mongodb-linux-x86_64-rhel70-4.2.7.tgz
配置環境變量
vi /etc/profile
添加如下圖橢圓和箭頭標註的內容
執行如下指令,使修改的環境變量立即生效
source /etc/profile
創建存放數據的文件目錄
mkdir -p ./data/db
創建存放日誌文件的目錄和具體的日誌文件
mkdir ./logs
cd logs
touch mongodb.log
新增mongodb配置文件mongodb.conf
vi mongodb.conf
dbpath=/usr/local/localsoftware/mongodb-linux-x86_64-rhel70-4.2.7/data/db #數據文件存放目錄
logpath=/usr/local/localsoftware/mongodb-linux-x86_64-rhel70-4.2.7/logs/mongodb.log #日誌文件存放目錄
port=27017 #端口
fork=true #以守護程序的方式啓用,即在後臺運行
logappend=true #日誌輸出
bind_ip=127.0.0.1 # 0.0.0.0允許遠程IP連接 127.0.0.1只允許本機訪問
啓動mongodb
./mongod -f mongodb.conf
連接mongodb
./mongo
mongodb 官方文檔 http://docs.mongodb.org/
安裝git
yum install git
輸入y,如下圖完成安裝
Yapi安裝
查看Yapi源碼倉庫 https://github.com/YMFE/yapi
按照Yapi源碼倉庫的提示,進行Yapi的安裝
安裝
使用Yapi提供的 yapi-cli 工具,部署 YApi 平臺是非常容易的。執行 yapi server 啓動可視化部署程序,輸入相應的配置和點擊開始部署,就能完成整個網站的部署。部署完成之後,可按照提示信息,執行 node/{網站路徑/server/app.js} 啓動服務器。在瀏覽器打開指定url, 點擊登錄輸入您剛纔設置的管理員郵箱,默認密碼爲 ymfe.org 登錄系統(默認密碼可在個人中心修改)。
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server
上述內容提示存在端口衝突,9090端口已經被佔用。執行如下指令,查看改端口的佔用情況。
lsof -i:9090
從上圖可以看出,gitlab的相關進程在9090端口,此時,我們先將gitlab服務停掉,保證Yapi的成功安裝,後續再處理端口衝突的問題,將Yapi的端口嘗試修改爲其它未被佔用的。
gitlab-ctl stop
再次,嘗試執行如下指令,進行Yapi的安裝
yapi server
此時,啓動成功。
在瀏覽器中輸入對應的網址,進入如下圖頁面,根據項目實際需要填寫頁面中相關內容。(由於在本Linux服務器中9090已被其它服務佔用,所以此處端口設置爲一個未被佔用的端口8700)
點擊“開始部署”按鈕後,出現部署日誌彈出框,如下圖
此時,部署成功。賬號名爲上面輸入的管理員郵箱,密碼爲“ymfe.org”。
切換到部署路徑/root/my-yapi,執行如下指令來啓動服務器
node vendors/server/app.js
在瀏覽器中輸入對應的訪問地址,進入如下圖頁面
進入登錄頁面,執行登錄操作
成功登錄,進入主操作頁面,如下圖
引導信息瀏覽完畢後,進入到主操作頁面,如下圖。
修改密碼,不再使用默認的密碼
此時,YApi已成功安裝並運行。
YApi的服務管理與升級
查看YApi源碼倉庫 https://github.com/YMFE/yapi ,裏面包含服務管理和後續升級的內容。
服務管理
利用pm2方便服務管理維護。
npm install pm2 -g //安裝pm2
cd {項目目錄}
pm2 start "vendors/server/app.js" --name yapi //pm2管理yapi服務
pm2 info yapi //查看服務信息
pm2 stop yapi //停止服務
pm2 restart yapi //重啓服務
升級
升級項目版本是非常容易的,並且不會影響已有的項目數據,只會同步 vendors 目錄下的源碼文件。
cd {項目目錄}
yapi ls //查看版本號列表
yapi update //更新到最新版本
yapi update -v {Version} //更新到指定版本