Api介面開發正確姿勢

2021-10-24 05:12:31 字數 867 閱讀 1107

3.響應說明

3.獲取資料

4.提交資料

5.更新資料

6.刪除資料

介面整體規範建議採用restful風格,客戶端與伺服器採用json通訊協議。

型別引數

資料格式

http狀態碼

200 ok 伺服器成功返回請求的資料

201 created 新建或修改資料成功

202 accepted 表示乙個請求已經進入後台排隊(非同步任務)

204 no content 刪除資料成功

400 invalid request 請求有錯誤,伺服器沒有進行新建或修改資料的操作(冪等操作)

401 unauthorized 沒有許可權(令牌、使用者名稱、密碼錯誤)

403 forbidden 得到授權(與401錯誤相對),但是訪問是被禁止的

404 not found 請求記錄不存在,伺服器沒有進行操作(冪等操作)

406 not acceptable 請求的格式不符合(比如使用者請求json格式,但是只有xml格式)

500 internal server error 伺服器發生錯誤,無法判斷發出的請求是否成功

返回格式

,// 返回資料物件

"msg":[

]// 對應的錯誤資訊

}

post /get/xx/:獲取乙個商品詳情資訊

例: post /add/xx 提交儲存乙個商品資訊

請求json資料:

例: post /update/xx 修改乙個商品資訊

請求json:

例: post /delete/xx/ 刪除乙個商品

例:

API 介面開發規範

api與使用者的通訊協議,總是使用https協議,確保互動資料的傳輸安全。應該盡量將api部署在專用網域名稱之下。如果確定api很簡單,不會有進一步擴充套件,可以考慮放在主網域名稱下。應該將api的版本號放入url。v 另一種做法是,將版本號放在http頭資訊中,但不如放入url方便和直觀。gith...

PHP開發API介面

在實際工作中,使用php寫api介面是經常做的,php寫好介面後,前台就可以通過鏈結獲取介面提供的資料,而返回的資料一般分為兩種情況,xml和json,在這個過程中,伺服器並不知道,請求的 是什麼,有可能是別人非法呼叫我們的介面,獲取資料,因此就要使用安全驗證。從圖中可以看得很清楚,前台想要呼叫介面...

API介面開發規範

整體規範建議採用restful方式來實施。協議 api與使用者的通訊協議,應該使用https協議,確保互動資料的安全傳輸。網域名稱 應該盡量將api部署在專用網域名稱下。如 api版本控制 方法一 將api的版本號放入uri,如 方法二 將版本號放在http頭資訊中。這種方法不如放入url中方便和直...