PPT
1.背景介紹
什么是接口文檔?
在項(xiàng)目開發(fā)中喂走，web項(xiàng)目的前后端分離開發(fā)，APP開發(fā)芋肠，需要由前后端工程師共同定義接口乎芳，編寫接口文檔帖池，
之后大家都根據(jù)這個(gè)接口文檔進(jìn)行開發(fā)奈惑，到項(xiàng)目結(jié)束前都要一直維護(hù)。
為什么要寫接口文檔睡汹？
1. 項(xiàng)目開發(fā)過程中前后端工程師有一個(gè)統(tǒng)一的文件進(jìn)行溝通交流開發(fā)
2肴甸、項(xiàng)目維護(hù)中或者項(xiàng)目人員更迭的時(shí)候，方便后期人員查看囚巴、維護(hù)
3. 規(guī)避一些不該屬于自己的任務(wù)而被強(qiáng)加于自己,等等問題.
2.知識(shí)剖析
接口文檔應(yīng)該包含哪些內(nèi)容?
約定,(比如對(duì)資源的操作應(yīng)該使用哪些方法)
標(biāo)題 .清晰明了,該接口實(shí)現(xiàn)原型圖上面哪一功能.
url: rest風(fēng)格url,并且具有統(tǒng)一標(biāo)識(shí)
請(qǐng)求類型:GET PUT POST DELETE
前后端負(fù)責(zé)人
請(qǐng)求參數(shù)
返回參數(shù)
接口完成狀態(tài)
3.常見問題
接口文檔的規(guī)范是什么
4.解決方案
url：以/a開頭原在，如果需要登錄才能調(diào)用的接口(如新增友扰、修改；前臺(tái)的用戶個(gè)人信息庶柿，資金信息等)后面需要加/u村怪，即：/a/u；中間一般放表名或者能表達(dá)這個(gè)接口的單詞浮庐；get方法甚负，如果是后臺(tái)通過搜索查詢列表，那么以/search結(jié)尾兔辅，如果是前臺(tái)的查詢列表腊敲，以/list結(jié)尾；url參數(shù)就不說了维苔。uri地址里不允許出現(xiàn)大寫字母碰辅，如果是兩個(gè)單詞拼接，用/分開
請(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ù)婴程。
5.編碼實(shí)戰(zhàn)
6.擴(kuò)展思考
衡量接口文檔的標(biāo)準(zhǔn)是什么
謝謝觀看
今天的分享就到這里啦抱婉，歡迎大家點(diǎn)贊、轉(zhuǎn)發(fā)蒸绩、留言、拍磚~
技能樹.IT修真院
“我們相信人人都可以成為一個(gè)工程師传蹈，現(xiàn)在開始步藕，找個(gè)師兄，帶你入門漱抓，掌控自己學(xué)習(xí)的節(jié)奏恕齐，學(xué)習(xí)的路上不再迷茫”仪或。
這里是技能樹.IT修真院，成千上萬的師兄在這里找到了自己的學(xué)習(xí)路線范删，學(xué)習(xí)透明化拷肌，成長可見化旨巷，師兄1對(duì)1免費(fèi)指導(dǎo)添忘〔赡牛快來與我一起學(xué)習(xí)吧~
www.jnshu.com/login/1/14708688
