YAPI官方提供了詳細的手冊,但是對於沒集成測試基礎的人來說並不是很友好,所以自己一邊搭建一邊摸索出一個對初學者比較友好的使用手冊。
目錄
1 登陸
YAPI提供獨立用戶庫、LDAP、oauth2等多種登陸方式,我推薦的方式是LDAP。
2 項目創建
新建項目前一定要先添加分組,因爲這個會涉及到後期的成員權限管理,將項目組的組長設置爲自己或者項目負責人。如果使用默認的個人空間,那你的項目永遠不會被別人看到,就失去了YAPI的意義。
新建項目時需要選中所屬的項目組,項目組內的成員纔有對應的權限使用項目中的接口。
3 接口創建
進入項目內,左邊導航可以看到接口列表,可以根據實際情況對接口進行分類,也可以只使用默認的“公共接口”分類“。添加接口時需要選擇所屬分類和請求方式。
配置接口的Reqeust和Response,支持多種形式,除開mock固定返回值,yapi還爲我們提供了豐富的mock變量
例如@name:返回隨機的人名,@id返回隨機的id,@string返回隨機的字符串,@ip返回隨機IP,@time返回隨機時間,yapi提供了上百種mock參數。
運行時可以定製不同的環境,推薦將mock地址設置爲,也可以指向預發佈或測試環境。
如果想根據不同的傳參返回不同的結果,可以在高級mock中添加期望。
4 Swagger的導入
Yapi提供了多種現有接口的導入方式,這裏只介紹如何對接swagger。
該段落需要一定研發基礎,非研發人員或者未使用swagger管理接口的項目可以跳過該章節。
url請求:
swagger地址:http://ip:port/swagger-ui.html
swagger的Json文件:http://ip:port/v2/api-docs
將swagger的Json文件保存爲文件,然後在yapi工具導入:
請注意導入模式的區別:
普通模式:不導入已存在的接口
智能合併:已存在的接口,將合併返回數據的 response,適用於導入了 swagger 數據,保留對數據結構的改動
完全覆蓋:不保留舊數據,完全使用新數據,適用於接口定義完全交給後端定義
5 測試集合
在項目中先創建測試集,每一個測試集是一次單元測試的主體,測試集下包含多個測試用例。
如果對某一個接口進行不同參數的多次測試,可以點擊“克隆用例“後修改參數。
測試用例中內置了多中快捷判斷斷言,可以點擊使用或者在此基礎上修改。
對測試集合選擇用例環境進行全case的測試,並生成測試報告:
6 成員管理
可以爲項目添加不同角色的用戶
7 變更通知
在主頁面關注某一個項目,該項目內接口發生變化後會通過郵件的方式將增量的方式通知給你。
8 項目文檔
雖然接口本身已經具備很好的可讀性,但是還是歡迎大家將項目重要的信息維護到yapi內置的wiki中。
以上是對YAPI入門級的使用建議,更深入的瞭解請閱讀