接口文檔通常由服務(wù)器端負(fù)責(zé)接口開(kāi)發(fā)的同事維護(hù)，對(duì)于每個(gè)接口的描述，應(yīng)包括以下內(nèi)容：
(1)請(qǐng)求URL德迹。
(2)接口的負(fù)責(zé)人名稱闹蒜。
(3)請(qǐng)求方式GET或POST寺枉。
(4)接口版本號(hào)。
(5)APP端應(yīng)發(fā)送的數(shù)據(jù)和格式绷落。
(6)服務(wù)器端的操作成功時(shí)姥闪，返回的數(shù)據(jù)和格式。
(7)服務(wù)器端的操作失敗時(shí)砌烁，返回的數(shù)據(jù)和格式筐喳。
最好使用版本管理工具如SVN管理接口文檔，每次把文檔提交到服務(wù)器時(shí)函喉，都要填寫(xiě)修改說(shuō)明避归，方便APP開(kāi)發(fā)人員和測(cè)試人員了解接口的變更。
