接口規(guī)范
接口規(guī)范
相關(guān)文章 : 0篇
瀏覽 : 次
首先接口分為四部分:方法、uri、請(qǐng)求參數(shù)、返回參數(shù)1、方法:新增(post) 修改(put) 刪除(delete) 獲取(get)2、uri:以/a開(kāi)頭,如果需要登錄才能調(diào)用的接口(如新增、修改;前臺(tái)的用戶(hù)個(gè)人信息,資金信息等)后面需要加/u,即:/a/u;中間一般放表名或者能表達(dá)這個(gè)接口的單詞;get方法,如果是后臺(tái)通過(guò)搜索查詢(xún)列表,那么以/search結(jié)尾,如果是前臺(tái)的查詢(xún)列表,以/list結(jié)尾;url參數(shù)就不說(shuō)了。3、請(qǐng)求參數(shù)和返回參數(shù),都分為5列:字段、說(shuō)明、類(lèi)型、備注、是否必填字段是類(lèi)的屬性;說(shuō)明是中文釋義;類(lèi)型是屬性類(lèi)型,只有String、Number、Object、Array四種類(lèi)型;備注是一些解釋?zhuān)蛘呖梢詫?xiě)一下例子,比如負(fù)責(zé)json結(jié)構(gòu)的情況,最好寫(xiě)上例子,好讓前端能更好理解;是否必填是字段的是否必填。
推薦產(chǎn)品
列表欄目