一望门、什么是接口文檔形娇？
在項(xiàng)目開發(fā)中，web項(xiàng)目的前后端分離開發(fā)筹误，APP開發(fā)桐早，需要由前后端工程師共同定義接口，編寫接口文檔厨剪，之后大家都根據(jù)這個(gè)接口文檔進(jìn)行開發(fā)哄酝，到項(xiàng)目結(jié)束前都要一直維護(hù)。
二祷膳、為什么要寫接口文檔陶衅？
- 項(xiàng)目開發(fā)過程中前后端工程師有一個(gè)統(tǒng)一的文件進(jìn)行溝通交流開發(fā)
- 項(xiàng)目維護(hù)中或者項(xiàng)目人員更迭，方便后期人員查看直晨、維護(hù)
三搀军、接口規(guī)范是什么？
首先接口分為四部分：請(qǐng)求方式勇皇、uri罩句、請(qǐng)求參數(shù)、返回參數(shù)
- 請(qǐng)求方式:新增(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ù)和返回參數(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è)單詞拼接慈格，用/分開
四.接口文檔實(shí)例
login.png
account.png
