erp項(xiàng)目或者其他開(kāi)發(fā)項(xiàng)目靶壮，或多或少都會(huì)接觸到關(guān)于接口的任務(wù)怔毛，可能是編寫(xiě)接口api文檔，也可能是調(diào)用接口腾降。無(wú)論是寫(xiě)或者用拣度，都避免不了要讀懂了解接口文檔的組成。
1.接口文檔是什么
在項(xiàng)目開(kāi)發(fā)匯總螃壤，web項(xiàng)目的前后端是分離開(kāi)發(fā)的抗果。應(yīng)用程序的開(kāi)發(fā)，需要由前后端工程師共同定義接口奸晴，編寫(xiě)接口文檔冤馏，之后大家都根據(jù)這個(gè)接口文檔進(jìn)行開(kāi)發(fā)，到項(xiàng)目結(jié)束前都要一直維護(hù)寄啼。
2.為什么要寫(xiě)接口文檔逮光？
1）項(xiàng)目開(kāi)發(fā)過(guò)程中前后端工程師有一個(gè)統(tǒng)一的文件進(jìn)行溝通交流開(kāi)發(fā)
2）項(xiàng)目維護(hù)中或者項(xiàng)目人員更迭的時(shí)候，方便后期人員查看墩划、維護(hù)
3.回顧接口的知識(shí)
要了解接口文檔的規(guī)范睦霎，首先要了解接口。接口分為四部分：請(qǐng)求方法走诞、url副女、請(qǐng)求參數(shù)、返回參數(shù)：
1）方法：常用的方法就是下面的四種：GET PUT POST DELETE
2）url：以/a開(kāi)頭蚣旱，如果需要登錄才能調(diào)用的接口（如新增碑幅、修改；前臺(tái)的用戶個(gè)人信息塞绿，資金信息等）后面需要加/u沟涨，即：/a/u；中間一般放表名或者能表達(dá)這個(gè)接口的單詞异吻。get方法裹赴，若果是后臺(tái)通過(guò)搜索查詢列表喜庞，那么以/search結(jié)尾，如果是前臺(tái)的查詢列表棋返，以/list結(jié)尾延都。uri地址里不遜于出現(xiàn)大寫(xiě)字母，如果是兩個(gè)單詞拼接睛竣，用/分開(kāi)
3）請(qǐng)求參數(shù)和返回參數(shù)：請(qǐng)求參數(shù)和返回參數(shù)都分為：字段晰房、說(shuō)明、類型射沟、備注殊者、是否必填這5列。
字段：類的屬性
說(shuō)明：中文釋義
類型：屬性的類型验夯，只有String猖吴、Number、Object挥转、Array四大類
備注：一些解釋語(yǔ)距误，或者寫(xiě)簡(jiǎn)單的示例
4）返回參數(shù)，要分兩種情況討論：
只返回接口調(diào)用成功或者失敱馕弧：code、reason
返回參數(shù)：字段趁俊、類型
3.常見(jiàn)問(wèn)題
一份規(guī)范的接口文檔應(yīng)該包括什么內(nèi)容
4.解決方案
除了上面提到的請(qǐng)求方法域仇、url、請(qǐng)求參數(shù)寺擂、返回參數(shù)以外暇务，還應(yīng)該添加接口示例、接口文檔版本號(hào)怔软、版本修改內(nèi)容垦细、版本修改時(shí)間、修改人挡逼，錯(cuò)誤代碼等括改。
5.示例：
下面是在網(wǎng)站上找到的一個(gè)接口文檔示例
