還在手工寫接口測試文檔,已經out了

接口文檔,顧名思義就是對接口說明的文檔。

好的接口文檔包含了對接口URL,參數以及輸出內容的說明,我們參照接口文檔就能編寫出一個個的測試用例。而且接口文檔詳細的話,測試用例編寫起來就會比較簡單,不容易遺漏。

還在手工寫接口測試文檔,已經out了

如果接口文檔信息不全或是沒有接口文檔的情況下,領導要求我們做接口自動化測試,這無異是一個非常艱辛的任務。但是編寫接口文檔的工作量很大,怎麼辦呢?有什麼自動化工具可以協助我們生成文檔呢?


眾裡尋他千百度,最近我發現一款工具可以大大解放我們工作,自動生成接口文檔。他就是YApi,先上圖說明,這是我在YApi中做的接口文檔,是不是蠻專業


還在手工寫接口測試文檔,已經out了


YApi介紹


1 YApi 是什麼呢

YMFE 是去哪兒網移動架構組(YMFE)簡稱,是由FE,iOS和Android工程師共同組成的


• Yapi 由 YMFE開源,旨在為開發、產品、測試人員提供更優雅的接口管理服務,可以幫助開發者輕鬆創建、發佈、維護 API。

• YApi 成熟的團隊管理扁平化項目權限配置滿足各類企業的需求

• 基於 websocket 的多人協作接口編輯功能和類 postman 測試工具,讓多人協作成倍提升開發效率

• Mock Server 易用的 Mock Server,再也不用擔心 mock 數據的生成了

• 自動化測試 完善的接口自動化測試,保證數據的正確性

• 數據導入 支持導入 swagger, postman, har 數據格式,方便遷移舊項目


2 試用地址如下

http://yapi.demo.qunar.com/

還在手工寫接口測試文檔,已經out了


3 這是一個Mock接口數據維護例子

還在手工寫接口測試文檔,已經out了


4 更為強大的是,可以支持數據導入,和文檔導出,可以把項目中的接口導出到HTML文件,同時在本地word中,就可以將HTML文檔轉換為word文檔,更方便我們轉播和存儲。

還在手工寫接口測試文檔,已經out了


安裝使用


5如何安裝呢,直接採用docker安裝最為簡單(需要有docker使用基礎)


5.1 安裝mogodb;

docker run -d --name mongo-yapi mongo;

還在手工寫接口測試文檔,已經out了


5.2 拉取yapi

docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi


5.3、初始化管理員賬號和服務

docker run -it --rm

--link mongo-yapi:mongo

--entrypoint npm

--workdir /api/vendors

registry.cn-hangzhou.aliyuncs.com/anoy/yapi

runinstall-server

還在手工寫接口測試文檔,已經out了


5.4、初始化管理員賬號和服務

啟動YApi服務

docker run -d

--name yapi

--link mongo-yapi:mongo

--workdir /api/vendors

-p 3002:3000

registry.cn-hangzhou.aliyuncs.com/anoy/yapi

server/app.js


5.5、訪問http://ip:3002

還在手工寫接口測試文檔,已經out了


6 mock平臺不足地方,如果涉及後臺業務,比如查詢數據庫 ,java方向可以採用springmvc 自己定製,這就需要具備測試開發能力了,例如自定義動態返回接口


還在手工寫接口測試文檔,已經out了

作  者:Testfan 極光老師

出  處:微信公眾號:自動化軟件測試平臺


分享到:


相關文章: