1.制定規範
開發前一定要設定好一個規範,例如要定好資料回傳的通用參數和格式。關於資料格式,用的比較多的有xml和json,我建議用json,因為json比xml的好處更多。
2.精簡的回傳資料
介面資料因符合需要什麼回傳什麼的原則,例如要查詢某個使用者的餘額和註冊時間,網頁裡面的做法可能是select * from user where
uid=1
,但是介面一定要select balance,regtime from user where uid=1
。因為介面回傳資料是要有開銷的,要流量的,能少回傳資料就盡量少返回,這樣可以大大的提升效能。
3.資料型態要嚴格
要注意資料的類型,整數型別的資料一定要轉為int,因為app客戶端開發的java、object- c語言對資料型別比較嚴格,型別不對會照成app閃退。
4.要寫接口文檔
一定要寫好接口文檔,並按照模組寫,而且還要書寫規範,最好的格式是:接口請求位址;請求參數(包括參數名、型別、是否為必填);測試參數舉例;傳回參數(參數名,並註明每個參數的意義)。這樣就算以後專案很大,以不會照成維護困難的問題。
5.保證程式碼正確性
要驗證保證程式碼正確無誤,而且產生環境中要屏蔽掉錯誤,避免頭部有額外的輸出,照成傳回的json等資料解析失敗而導致app閃退等。
6.要最佳化程式碼的效能
app要求反應迅速,這樣才能給使用者比較好的體驗感。所以行動介面端在處理業務邏輯的時候,要避免不要執行太複雜的sql語句,或是含有大量的循環,能做成快取的盡量做緩存,例如將首頁的熱點模組資訊可以存到redis快取中。在不考慮網速的情況下,比較理想的介面響應時間應該是200毫秒以內。
7.不要隨意更改舊介面
app不像網頁,app一旦發布,有人使用之後,介面就不要亂修改了。以後升級也是,修改要在保證介面原有結構之上進行額外的擴展,否則會導致呼叫舊版介面的app出現bug。
8. 注意介面的安全性
安全高於一切,必須確保介面的安全性。電話號碼等敏感資訊在傳輸的過程中一定要加密,否則可能會被別人抓包到。拿取用戶資訊的介面一定要驗證權限,以防止介面被惡意調用,洩密用戶訊息,甚至竄改資訊。
推薦教學:PHP影片教學
#以上是php開發介面要注意什麼的詳細內容。更多資訊請關注PHP中文網其他相關文章!