介面規範 API介面

2021-10-19 13:27:57 字數 783 閱讀 7311

​ 同通過網路,規定前後臺資訊互動規則的url連線,是前後臺資訊互動的媒介。

​ 1、url;

​ 2、請求方式:get、post、put、patch、delete;

​ 3、請求引數:json或xml格式的key-value型別資料;

​ 4、響應結果:json或者xml格式的資料

​ 編寫介面文件可以使用去哪網技術中心的乙個開源視覺化介面管理平台yapi。

​ ​ rest全稱是representational state transfer,中文意思是表述性狀態轉移,首次出現是在2023年roy fielding的博士**中。

​ 1、資料安全的保障

​ url連線一般採用https協議進行資料傳輸,可以提高資料互動過程中的安全性。

​ 2、介面特徵的表現

​ 使用api關鍵字標識介面:

​ 注意:出現api,就代表該請求的url連線是為了完成前後臺資料互動的。

​ 3、多版本資料共存

​ 與就是不同版本資料的體現。

​ 4、資料即資源

​ 介面即前後端互動的媒介,互動的資料即為資源。

​ ​ 推薦資源寫複數形式,便於理解。

​ 連線中不要出現操作資源的動詞,例如

​ 沒有明確資源的介面可以使用動詞,或者東西就是介面的核心含義可以使用動詞。

​ 例:或

1、正常響應

2、重定向響應

響應狀態碼3xx

3、客戶端異常

響應狀態碼4xx

4、伺服器異常

響應狀態碼5xx

API介面規範

對於資源的具體操作型別,由http動詞表示。常用的http動詞有下面四個 括號裡是對應的sql命令 get select 從伺服器取出資源 一項或多項 post create 在伺服器新建乙個資源。put update 在伺服器更新資源 客戶端提供改變後的完整資源 delete delete 從伺服...

api介面規範

api與使用者的通訊協議,總是使用https協議,確保互動資料的傳輸安全。應該將api的版本號放入url。另一種做法是,將版本號放在http頭資訊中,但不如放入url方便和直觀。採用多版本並存,增量發布的方式 v n代表版本號,分為整形和浮點型 整形的版本號 大功能版本發布形式 具有當前版本狀態下的...

API 介面開發規範

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