一、雙方統(tǒng)一接口開發(fā)文檔為了提升開發(fā)效率及溝通方便，需要建立規(guī)范的開發(fā)文檔。 一般保護(hù)接口的功能或頁面、接口地址、接口參數(shù)、接口返回值等說明。
參考文檔格式： 
二、注意以下
分版本，為后面接口升級做好打算。
提供密鑰和token。確保數(shù)據(jù)不被篡改。
讀數(shù)據(jù)用get，修改數(shù)據(jù)用post。
接口返回值格式統(tǒng)一結(jié)構(gòu)。 用JSON格式輸出
接口記錄日志。記錄請求參數(shù)、占用內(nèi)存、響應(yīng)時(shí)間、響應(yīng)時(shí)長。方便后續(xù)優(yōu)化。
提供統(tǒng)一的錯誤碼。每個數(shù)字代表一種錯誤，需要在文檔中說明。錯誤分系統(tǒng)錯誤和業(yè)務(wù)邏輯錯誤。 建立接口文檔。
記錄每個接口的用途，參數(shù)列表，返回值說明。同時(shí)給出使用例子。
一、雙方統(tǒng)一接口開發(fā)文檔
為了提升開發(fā)效率及溝通方便，需要建立規(guī)范的開發(fā)文檔。
一般保護(hù)接口的功能或頁面、接口地址、接口參數(shù)、接口返回值等說明。
參考文檔格式：
二、注意以下
分版本，為后面接口升級做好打算。
提供密鑰和token。確保數(shù)據(jù)不被篡改。
讀數(shù)據(jù)用get，修改數(shù)據(jù)用post。
接口返回值格式統(tǒng)一結(jié)構(gòu)。 用JSON格式輸出
接口記錄日志。記錄請求參數(shù)、占用內(nèi)存、響應(yīng)時(shí)間、響應(yīng)時(shí)長。方便后續(xù)優(yōu)化。
提供統(tǒng)一的錯誤碼。每個數(shù)字代表一種錯誤，需要在文檔中說明。錯誤分系統(tǒng)錯誤和業(yè)務(wù)邏輯錯誤。 建立接口文檔。
記錄每個接口的用途，參數(shù)列表，返回值說明。同時(shí)給出使用例子。
相關(guān)推薦：
詳解app接口之token
laravel編寫APP接口（API）
PHP開發(fā)APP接口視頻教程
以上就是PHP開發(fā)APP接口需要注意哪些問題的詳細(xì)內(nèi)容，更多請關(guān)注php中文網(wǎng)其它相關(guān)文章！