PHP開發APP介面注意事項

來源:互聯網
上載者:User
一、雙方統一介面開發文檔

為了提升開發效率及溝通方便,需要建立規範的開發文檔。
一般保護介面的功能或頁面、介面地址、介面參數、介面傳回值等說明。
參考文檔格式:

二、注意以下

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

').addClass('pre-numbering').hide(); $(this).addClass('has-numbering').parent().append($numbering); for (i = 1; i <= lines; i++) { $numbering.append($('
  • ').text(i)); }; $numbering.fadeIn(1700); }); });

    以上就介紹了 PHP開發APP介面注意事項,包括了方面的內容,希望對PHP教程有興趣的朋友有所協助。

  • 聯繫我們

    該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

    如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

    A Free Trial That Lets You Build Big!

    Start building with 50+ products and up to 12 months usage for Elastic Compute Service

    • Sales Support

      1 on 1 presale consultation

    • After-Sales Support

      24/7 Technical Support 6 Free Tickets per Quarter Faster Response

    • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.