API介面規範

2021-09-08 13:40:05 字數 660 閱讀 7605

對於資源的具體操作型別,由http動詞表示。

常用的http動詞有下面四個(括號裡是對應的sql命令)。

get(select):從伺服器取出資源(一項或多項)。

post(create):在伺服器新建乙個資源。

put(update):在伺服器更新資源(客戶端提供改變後的完整資源)。

delete(delete):從伺服器刪除資源。

下面是一些例子。

get /product:列出所有商品

post /product:新建乙個商品

get /product/id:獲取某個指定商品的資訊

put /product/id:更新某個指定商品的資訊

delete /product/id:刪除某個商品

get /product/id/purchase :列出某個指定商品的所有投資者

get /product/id/purchase/id:獲取某個指定商品的指定投資者資訊

api引數規範

多api中,表示相同意義的引數的名稱要保持相同。同理api的返回值也要確保相同意義的返回值使用相同的名稱。

例如:在建立商品與更新商品的兩個api中都使用到了商品簡介,則要確保使用的引數名稱(product_desc)一致。

介面規範 API介面

同通過網路,規定前後臺資訊互動規則的url連線,是前後臺資訊互動的媒介。1 url 2 請求方式 get post put patch delete 3 請求引數 json或xml格式的key value型別資料 4 響應結果 json或者xml格式的資料 編寫介面文件可以使用去哪網技術中心的乙個開...

api介面規範

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

API 介面開發規範

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