3.1接口文檔的介紹
3.1.1什么是接口文檔
在項(xiàng)目開發(fā)中蕉扮，web項(xiàng)目的前后端分離開發(fā)整胃，需要由前后端工程師共同定義接口，編寫接口文檔之后大家根據(jù)這個(gè)接口文檔進(jìn)行開發(fā)喳钟，到項(xiàng)目結(jié)束前都要一直維護(hù)屁使。
3.1.2接口規(guī)范是什么？
首先接口分為四部分：方法奔则、uri蛮寂、請(qǐng)求參數(shù)、返回參數(shù)
方法：新增（post）修改（put）刪除（delete）獲纫撞纭（get）
uri：以/a開頭酬蹋，如果需要登錄才能調(diào)用的接口(如新增、修改抽莱；前臺(tái)的用戶個(gè)人信息范抓，資金信息等)后面需要加/u，即：/a/u食铐；中間一般放表名或者能表達(dá)這個(gè)接口的單詞匕垫；get方法，如果是后臺(tái)通過搜索查詢列表虐呻，那么以/search結(jié)尾象泵，如果是前臺(tái)的查詢列表，以/list結(jié)尾铃慷；url參數(shù)就不說了单芜。
請(qǐng)求參數(shù)，分為5列：字段犁柜、說明洲鸠、類型、備注、是否必填字段是類的屬性扒腕；說明是中文釋義绢淀；類型是屬性類型，只有String瘾腰、Number皆的、Object、Array四種類型蹋盆；備注是一些解釋费薄，或者可以寫一下例子，比如負(fù)責(zé)json結(jié)構(gòu)的情況栖雾，最好寫上例子楞抡，好讓前端能更好理解；是否必填是字段的是否必填析藕。
返回參數(shù)召廷，結(jié)構(gòu)有幾種情況：1、如果只返回接口調(diào)用成功還是失斦穗省（如新增竞慢、刪除、修改等）治泥，則只有一個(gè)結(jié)構(gòu)體：code和message兩個(gè)參數(shù)筹煮；2、如果要返回某些參數(shù)车摄，則有兩個(gè)結(jié)構(gòu)體：1是code/mesage/data寺谤，2是data里寫返回的參數(shù),data是object類型；3吮播、如果要返回列表，那么有三個(gè)結(jié)構(gòu)體眼俊，1是code/mesage/data,data是object意狠，里面放置page/size/total/totalPage/list 5個(gè)參數(shù)，其中l(wèi)ist是Arrary類型疮胖，list里放object环戈，object里是具體的參數(shù)。
注意：uri地址里不允許出現(xiàn)大寫字母澎灸，如果是兩個(gè)單詞拼接院塞，用/分開
3.2 接口測(cè)試用例模板介紹
3.2.1 核心要素
用例編號(hào) ,用例標(biāo)題，模塊性昭，優(yōu)先級(jí)拦止，前提條件，請(qǐng)求類型，請(qǐng)求參數(shù)汹族，操作步驟萧求，預(yù)期結(jié)果
3.2.2 模板
3.3 接口測(cè)試報(bào)告
案例1：get請(qǐng)求
案例2：post請(qǐng)求
3.3.1 報(bào)告要素
系統(tǒng)接口概況，測(cè)試目的與范圍顶瞒，測(cè)試工具及資源夸政，測(cè)試記錄及結(jié)果分析，測(cè)試結(jié)論
