什麼是YApi
github: https://github.com/YMFE/yapi
官網上是這麼介紹的:YApi 是一個可本地部署的、打通前後端及QA的、可視化的接口管理平臺 https://hellosean1025.github....
可以這麼說YApi兼具swagger,rap2,postman的各項優點
why YApi
如果你想要一個好用的接口管理平臺,那麼你需要YApi或swagger。YApi支持各種數據導入,實現無縫遷移。
如果你想mock接口,那麼你需要YApi或rap2。
如果你想做接口自動化測試,那麼你需要YApi或postman。
如果你擔心數據放在其他平臺不安全,那麼你也需要YApi。YApi支持本地化部署。
此外,YApi還有很多特性。
這麼優秀,難道你還不準備用嗎?
YApi有哪些功能特性
- 可視化接口管理
- 數據mock
- 自動化接口測試
- 數據導入(各種,包括swagger、har、postman、json、命令行)
- 權限管理
- 支持本地化部署
- 支持插件
- 支持二次開發
內網部署
如果只想先看看,可以跳過此節,直接使用官方demo http://yapi.demo.qunar.com/
這裏需要您的環境滿足
- nodejs(7.6+)
- mongodb(2.6+)
- git
使用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
👇看截圖
我們按照提示進入安裝目錄,後執行以下命令
node vendors/server/app.js
然後打開 http://localhost:3000/, 可以看到跟官方demo一樣的界面。
至此,我們已經本地部署好服務裏。🍺
可視化的接口管理
接口管理頁面包括預覽、編輯、運行和高級mock,這樣看是不是很清爽😬
數據導入
yapi支持swagger、HAR、postman、json、命令行五種導入
這裏以HAR爲例: 我們先打開開發者工具,然後打開一個網站:如 美團外賣 https://h5.waimai.meituan.com...
如圖:點擊下載
接下來,如圖
導入成功後,我們就多了幾個接口了,是不是很完美 😁
數據mock
yapi的mock包括很多種
mock請求參數和返回參數
如圖yapi提供給我們兩種mock參數的形式
這裏我們把image mock成圖片
點擊上圖鏈接
這裏我們成功mock了一個接口
想想是不是經常遇到後端接口沒有ready的情況,現在有了yapi是不是一切都迎刃而解了呢🤔
想了解更多,請查看官方文檔 https://hellosean1025.github....
高級mock
點擊高級mock,這裏我們加了一個字段
現在來試試看吧
是不是很爽?
全局mock腳本
自動化接口測試
這裏我們用cnode爲例,接口1:/topics 接口2:/topic/:id, 其中接口2中的id由接口1返回
添加一個叫cnode的項目,注意設置好域名
再導入兩個cnode接口
運行,沒有問題
下面👇是重點
下面開始關聯兩個接口,即從接口1返回的數據中獲取id,並賦值給接口2的參數
點擊更新
開始測試或者服務端測試
狀態pass,查看測試報告
今天就介紹到這裏。
更多文章請關注 https://github.com/abc-club/f...
喜歡請star
喜歡請star
喜歡請star