接口注意的事項

1.制定規(guī)范

開發(fā)前一定要定好一個規(guī)范,比如要定好數(shù)據(jù)返回的通用參數(shù)和格式。關(guān)于數(shù)據(jù)格式,用的比較多的有xml和json,我建議用json,因為json比xml的好處更多。

2.精簡的返回數(shù)據(jù)

接口數(shù)據(jù)因符合需要什么返回什么的原則,比如要查詢某個用戶的余額和注冊時間,網(wǎng)頁里面的做法可能是select * from user where uid=1,但是接口一定要select

balance,regtime from user where uid=1。因為接口返回數(shù)據(jù)是要有開銷的,要流量的,能少返回數(shù)據(jù)就盡量少返回,這樣可以大大的提高性能。

3.數(shù)據(jù)類型要嚴(yán)格

要注意數(shù)據(jù)的類型,整數(shù)類型的數(shù)據(jù)一定要轉(zhuǎn)為int,因為app客戶端開發(fā)的java、object-c語言對數(shù)據(jù)類型比較嚴(yán)格,類型不對會照成app閃退。

4.要寫接口文檔

一定要寫好接口文檔,并按照模塊寫,而且還要書寫規(guī)范,最好的格式是:

接口請求地址;請求參數(shù)(包括參數(shù)名、類型、是否必填);測試參數(shù)舉例;返回參數(shù)(參數(shù)名,并注明每個參數(shù)的含義)。

這樣哪怕以后項目很大,以不會照成維護(hù)困難的問題。

5.保證代碼正確性

要驗證保證代碼正確無誤,而且生成環(huán)境中要屏蔽掉錯誤,避免頭部有額外的輸出,照成返回的json等數(shù)據(jù)解析失敗而導(dǎo)致app閃退等。

6.要優(yōu)化代碼的性能

app要求響應(yīng)迅速,這樣才能給用戶比較好的體驗感。所以移動接口端在處理業(yè)務(wù)邏輯的時候,要避免不要執(zhí)行太復(fù)雜的sql語句,或者含有大量的循環(huán),能做成緩存的盡量做緩存,比如將首頁的熱點(diǎn)模塊信息可以存到redis緩存中。在不考慮網(wǎng)速的情況下,比較理想的接口響應(yīng)時間應(yīng)該是200毫秒以內(nèi)。

7.不要隨意更改舊接口

app不像網(wǎng)頁,app一旦發(fā)布,有人使用之后,接口就不要亂修改了。以后升級也是,修改要在保證接口原有結(jié)構(gòu)之上進(jìn)行額外的擴(kuò)展,否則會導(dǎo)致調(diào)用舊版接口的app出現(xiàn)bug。

8.注意接口的安全

安全高于一切,必須要保證接口的安全。電話號碼等敏感信息在傳輸?shù)倪^程中一定要加密,否則可能會被別人抓包到。拿取用戶信息的接口一定要驗證權(quán)限,以防止接口被惡意調(diào)用,泄密用戶信息,甚至篡改信息。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

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

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 136,612評論 19 139
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 179,145評論 25 708
  • 點(diǎn)擊查看原文 Web SDK 開發(fā)手冊 SDK 概述 網(wǎng)易云信 SDK 為 Web 應(yīng)用提供一個完善的 IM 系統(tǒng)...
    layjoy閱讀 14,316評論 0 15
  • 思維解: 最近幾年 越來越多的人進(jìn)入了新媒體行業(yè),很多人都想知道,新媒體行業(yè)到底賺不賺錢?能持續(xù)多久? 我們今天就...
    文玩收藏集閱讀 678評論 0 1
  • 1. telecom carriers 電信運(yùn)營商 2. roaming charges 漫游費(fèi) 3. Deale...
    Bebevino閱讀 146評論 0 0

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