接口請求參數(shù)如何定義

  • 請求方式有很多,但是由于為了統(tǒng)一,所以目前所有的接口的定義都定義成為了POST方式,這樣雖然不完全遵守restful的定義,但是也有一些好處。
  • 可以對參數(shù)進(jìn)行一定的保護(hù)
  • 可以避免超出GET請求參數(shù)長度限制
  • 接口定義都是盡量都是由一個單詞組成,如果出現(xiàn)多個單詞的情況下,通過中劃線-來進(jìn)行分割。不使用Java的駝峰命名法。
  • 接口業(yè)務(wù)參數(shù)如果是簡單類型,并且數(shù)量少于3個,則使用application/x-www-form-urlencoded方式進(jìn)行接受。如果是復(fù)雜對象類型,那么就使用application/json放手進(jìn)行接受。
  • 一些公共參數(shù)比如設(shè)備號、版本號、ip等都放到HTTP的Header里面,不要和業(yè)務(wù)接口參數(shù)混到一起。

公共請求參數(shù)總結(jié)

  • 設(shè)備id
  • 用戶憑證
  • 終端類型id
  • 基礎(chǔ)信息(平臺|系統(tǒng)版本|渠道|版本號|機(jī)型|網(wǎng)絡(luò)類型)
  • 請求唯一標(biāo)志(traceid|spanid)
  • 地理信息 (經(jīng)度|緯度)
  • 客戶端時間
  • 接口所在頁面名稱
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容