1. 程式人生 > >PHP開發APP介面注意事項

PHP開發APP介面注意事項

一、雙方統一介面開發文件

為了提升開發效率及溝通方便,需要建立規範的開發文件。
一般保護介面的功能或頁面、介面地址、介面引數、介面返回值等說明。
參考文件格式:
這裡寫圖片描述

二、注意以下

  1. 分版本,為後面介面升級做好打算。
  2. 提供金鑰和token。確保資料不被篡改。
  3. 讀資料用get,修改資料用post。
  4. 介面返回值格式統一結構。 用JSON格式輸出
  5. 介面記錄日誌。記錄請求引數、佔用記憶體、響應時間、響應時長。方便後續優化。
  6. 提供統一的錯誤碼。每個數字代表一種錯誤,需要在文件中說明。錯誤分系統錯誤和業務邏輯錯誤。 建立介面文件。
  7. 記錄每個介面的用途,引數列表,返回值說明。同時給出使用例子。