2、接口測試流程
一、需求分析
- 工作方式:基于產(chǎn)品經(jīng)理的需求文檔進(jìn)行會議討論
- 執(zhí)行要點(diǎn):
- 需要提前閱讀需求文檔
- 通過團(tuán)隊(duì)會議確認(rèn)需求細(xì)節(jié)
- 屬于基礎(chǔ)工作能力,無需專門學(xué)習(xí)
二、接口文檔解析
1. 基本概念
- 定位:接口測試的第一步關(guān)鍵工作
- 核心問題:
- 明確接口文檔的定義和作用
- 確定需要從文檔中提取的關(guān)鍵信息
2. 解析目標(biāo)
- 關(guān)鍵任務(wù):
- 理解接口文檔的結(jié)構(gòu)和內(nèi)容
- 提取測試所需的接口參數(shù)和規(guī)范
- 為后續(xù)測試用例設(shè)計做準(zhǔn)備
- 工作產(chǎn)出:填寫《接口文檔解析模板.xlsx》
三、接口測試完整流程
- 標(biāo)準(zhǔn)流程:
- 需求分析(產(chǎn)品需求文檔)
- 接口文檔解析(API文檔)
- 設(shè)計測試用例(Excel表格)
- 準(zhǔn)備測試腳本(Postman/Python)
- 執(zhí)行測試并跟蹤缺陷
- 生成測試報告
- 自動化持續(xù)集成(可選)
- 流程特點(diǎn):
- 線性推進(jìn)的工作流程
- 各環(huán)節(jié)有明確的交付物
自動化集成屬于進(jìn)階選項(xiàng)
-
- 注:所有時間戳均基于PPT文件名自動生成,圖片路徑保持原始命名格式。筆記內(nèi)容嚴(yán)格遵循課程記錄,未添加任何非講授內(nèi)容。
四、接口文檔解析
1. 接口文檔解析
1)接口文檔
- 定義:接口文檔(API文檔)是由后端開發(fā)編寫的,用于描述接口信息的文檔,全稱為Application Programming Interface。
- 作用:
- 團(tuán)隊(duì)協(xié)同:實(shí)現(xiàn)開發(fā)團(tuán)隊(duì)的工作協(xié)同配合
- 規(guī)范約束:作為項(xiàng)目更新修改的同步維護(hù)依據(jù)
- 編寫者:后端開發(fā)工程師(因?yàn)榻涌跍y試主要針對后端)
- 核心內(nèi)容:主要描述接口的各種信息
2)各種接口文檔示例
- 愛家租房網(wǎng)接口文檔
-
- 文檔形式:Word文檔格式
- 主要內(nèi)容:
- 項(xiàng)目說明:微服務(wù)架構(gòu)的租房業(yè)務(wù)項(xiàng)目案例
- 全局錯誤碼:
- 實(shí)際應(yīng)為"狀態(tài)碼",為避免與HTTP狀態(tài)碼混淆而稱為錯誤碼
- 采用4位數(shù)字編碼(如4000系列),區(qū)別于HTTP的3位狀態(tài)碼
- 示例:
- 0:成功(RECODE_OK)
- 4001:數(shù)據(jù)庫查詢錯誤(RECODE_DBERR)
- 4101:用戶未登錄(RECODE_SESSIONERR)
- 特點(diǎn):
- 錯誤碼不一定表示錯誤,成功時也可返回
- 開發(fā)團(tuán)隊(duì)需統(tǒng)一使用預(yù)設(shè)的錯誤碼進(jìn)行狀態(tài)判定
- 修改記錄
-
- 作用:記錄接口文檔的變更歷史,確保團(tuán)隊(duì)信息同步
- 內(nèi)容格式:
- 管理要求:
- 任何修改都需要記錄并通知項(xiàng)目組
- 團(tuán)隊(duì)成員需按照修改后的文檔規(guī)范執(zhí)行
- 項(xiàng)目相關(guān)接口文檔
-
- 結(jié)構(gòu)特點(diǎn):
- 按功能模塊分類(如首頁相關(guān)、登錄相關(guān)等)
- 每個接口包含:
- 服務(wù)編號
- 服務(wù)名稱
- 請求類型(GET/POST等)
- URL路徑
- 調(diào)用函數(shù)名
- 示例接口:
- 發(fā)送登錄信息服務(wù):
- 請求方法:POST
- URL:/api/v1.0/sessions
- 函數(shù):PostLogin
- 發(fā)送登錄信息服務(wù):
- 詳細(xì)說明:
- 功能描述:發(fā)送用戶登錄信息進(jìn)行登錄
- 完整URL:需拼接系統(tǒng)域名(如http://xx.com/api/v1.0/sessions)
- 請求參數(shù):
- 響應(yīng)示例:
- 成功:
- 失敗:
- 結(jié)構(gòu)特點(diǎn):
- IHRM人力資源管理系統(tǒng)接口文檔
-
- 文檔特點(diǎn):
- 單獨(dú)列出系統(tǒng)路徑(如http://ihrm-test.itheima.net)
- 接口Path只包含資源路徑,需拼接系統(tǒng)路徑
- 接口規(guī)范:
- Path:/api/sys/login
- Method:POST
- 請求參數(shù):
- Headers:
- Content-Type: application/json
- Body:
- Headers:
- 響應(yīng)規(guī)范:
- 成功狀態(tài)碼:200
- 錯誤碼:
- 10000:操作成功
- 99999:系統(tǒng)繁忙
- 術(shù)語說明:
- 請求參數(shù):包含請求頭和請求體數(shù)據(jù)(也稱請求數(shù)據(jù))
- 注意:與URL查詢參數(shù)是不同的概念
- 文檔特點(diǎn):
3)傳統(tǒng)風(fēng)格接口和RESTful風(fēng)格接口的小結(jié)
- 接口風(fēng)格概述
-
- 傳統(tǒng)風(fēng)格接口:
- 僅使用GET和POST方法
- URL不唯一,可能包含操作動詞
- 統(tǒng)一返回200狀態(tài)碼
- RESTful風(fēng)格接口:
- 使用GET、POST、PUT、DELETE等方法
- URL唯一且僅表示資源
- 返回狀態(tài)碼靈活(200、201、204等)
- 傳統(tǒng)風(fēng)格接口:
- RESTful風(fēng)格接口特點(diǎn)
- 方法對應(yīng):HTTP請求方法與操作類型一一對應(yīng)
- GET-查、POST-增、PUT-改、DELETE-刪
- URL設(shè)計:
- 不能從URL看出操作類型
- 需結(jié)合請求方法識別操作
- 狀態(tài)碼使用:
- 查詢成功:200
- 添加成功:201
- 刪除成功:204
- 方法對應(yīng):HTTP請求方法與操作類型一一對應(yīng)
- 接口文檔解析
-
- 請求參數(shù):
- mobile:必須,手機(jī)號
- password:必須,密碼
- 響應(yīng)結(jié)構(gòu):
- success:布爾類型,操作成功標(biāo)記
- code:整型,錯誤碼
- message:字符串,消息描述
- data:字符串,令牌(token)
- 請求參數(shù):
- 預(yù)期結(jié)果與實(shí)際結(jié)果
- 預(yù)期結(jié)果:
- 來自接口文檔
- 是理論上的響應(yīng)示例
- 實(shí)際結(jié)果:
- 通過實(shí)際請求獲得
- 可從瀏覽器開發(fā)者工具或Postman獲取
- 區(qū)別:
- 文檔只能提供預(yù)期結(jié)果
- 實(shí)際結(jié)果需通過真實(shí)請求獲取
- 預(yù)期結(jié)果:
- 添加員工接口分析
-
- 請求頭:
- Content-Type:application/json
- Authorization:Bearer + token
- 請求體參數(shù):
- 必填項(xiàng):username、mobile、workNumber
- 非必填:timeOfEntry、formOfEmployment等
- 響應(yīng)示例:
- 成功:返回新增員工ID
- 失敗:返回錯誤碼和消息
- 請求頭:
- 接口文檔形式
- 常見格式:
- Word文檔
- PDF文檔
- Excel表格
- 在線文檔工具
- 文檔特點(diǎn):
- 通常不完整,需自行補(bǔ)充
- 不同公司格式差異大
- 中小公司文檔通常較簡略
- 常見格式:
2. 接口文檔解析知識總結(jié)
1)接口文檔基本概念
- 定義與別名:接口文檔是描述接口相關(guān)信息的文檔,也稱為API文檔
- 編寫主體:通常由后端開發(fā)工程師負(fù)責(zé)編寫
- 核心功能:用于詳細(xì)說明接口的各項(xiàng)技術(shù)參數(shù)和功能特性
- 內(nèi)容要素:包含接口名稱、功能描述、請求參數(shù)要求、返回結(jié)果格式等關(guān)鍵信息
2)接口文檔解析的必要性
- 自動化基礎(chǔ):是接口自動化測試腳本開發(fā)的前提條件
- 規(guī)范保障:確保測試人員準(zhǔn)確理解接口規(guī)范和要求
- 效率提升:避免因理解偏差導(dǎo)致的測試用例設(shè)計錯誤
- 協(xié)作橋梁:作為開發(fā)與測試團(tuán)隊(duì)之間的技術(shù)溝通媒介
3)接口文檔解析流程
- 前置步驟:在需求分析之后立即進(jìn)行
- 核心環(huán)節(jié):包括測試用例設(shè)計、腳本開發(fā)等關(guān)鍵工作
- 后續(xù)關(guān)聯(lián):直接影響測試執(zhí)行和缺陷跟蹤效果
- 可選擴(kuò)展:可延伸至持續(xù)集成環(huán)節(jié)實(shí)現(xiàn)自動化部署
4)接口風(fēng)格類型
- 傳統(tǒng)風(fēng)格:采用動詞性接口命名方式
- RESTful風(fēng)格:基于HTTP方法的資源操作規(guī)范
- 對比要點(diǎn):主要區(qū)別在于URL設(shè)計理念和參數(shù)傳遞方式
浙公網(wǎng)安備 33010602011771號