還在手工寫介面測試文件嗎,已經out了
01 前言
介面文件,顧名思義就是對介面說明的文件。好的介面文件包含了對介面URL,引數以及輸出內容的說明,我們參照介面文件就能編寫出一個個的測試用例。而且介面文件詳細的話,測試用例編寫起來就會比較簡單,不容易遺漏。
如果介面文件資訊不全或是沒有介面文件的情況下,領導要求我們做介面自動化測試,這無異是一個非常艱辛的任務。但是編寫介面文件的工作量很大,怎麼辦呢?有什麼自動化工具可以協助我們生成文件呢?
眾裡尋他千百度,最近我發現一款工具可以大大解放我們工作,自動生成介面文件。他就是YApi,先上圖說明,這是我在YApi中做的介面文件,是不是蠻專業
02 YApi介紹
1、YApi 是什麼呢
YMFE是去哪兒網移動架構組(YMFE)簡稱,是由FE,iOS和Android工程師共同組成的
-
Yapi由YMFE開源,旨在為開發、產品、測試人員提供更優雅的介面管理服務,可以幫助開發者輕鬆建立、釋出、維護 API。
-
YApi成熟的團隊管理扁平化專案許可權配置滿足各類企業的需求
-
基於websocket的多人協作介面編輯功能和類postman測試工具,讓多人協作成倍提升開發效率
-
Mock Server易用的Mock Server,再也不用擔心mock 資料的生成了
-
自動化測試完善的介面自動化測試,保證資料的正確性
-
資料匯入支援匯入 swagger, postman, har 資料格式,方便遷移舊專案
2、介面如下
3、這是一個Mock介面資料維護例子
4、更為強大的是:
可以支援資料匯入,和文件匯出,可以把專案中的介面匯出到HTML檔案,同時在本地word中,就可以將HTML文件轉換為word文件,更方便我們轉播和儲存。
03
安裝使用
如何安裝呢?直接採用docker安裝最為簡單(需要有docker使用基礎)
1、安裝mogodb;
docker run -d --name mongo-yapi mongo;
2、拉取yapi
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi
3、初始化管理員賬號和服務
docker run -it --rm
--link mongo-yapi:mongo
--entrypoint npm
--workdir /api/vendors
registry.cn-hangzhou.aliyuncs.com/anoy/yapi
runinstall-server
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、訪問http://ip:3002
6、mock平臺不足地方:
如果涉及後臺業務,比如查詢資料庫 ,java方向可以採用springmvc 自己定製,這就需要具備測試開發能力了,例如自定義動態返回介面