api介面規範

api與使用者的通訊協議，總是使用https協議，確保互動資料的傳輸安全。

應該將api的版本號放入url。

另一種做法是，將版本號放在http頭資訊中，但不如放入url方便和直觀。

採用多版本並存，增量發布的方式

v n代表版本號,分為整形和浮點型

整形的版本號: 大功能版本發布形式；具有當前版本狀態下的所有api介面 ,例如：v1,v2

浮點型：為小版本號，只具備補充api的功能，其他api都預設呼叫對應大版本號的api 例如：v1.1 v2.2

在restful架構中，每個**代表一種資源（resource），所以**中不能有動詞，只能有名詞，而且所用的名詞往往與資料庫的**名對應。一般來說，資料庫中的表都是同種記錄的"集合"（collection），所以api中的名詞也應該使用複數。

舉例來說，有乙個api提供動物園（zoo）的資訊，還包括各種動物和雇員的資訊，則它的路徑應該設計成下面這樣。

常用的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：獲取某個指定商品的指定投資者資訊

為了保障前後端的資料互動的順暢，建議規範資料的返回，並採用固定的資料格式封裝。

介面返回模板：

||,

msg:』』

}

=0表示成功

<0 表示有異常

》0 表示介面有部分執行失敗

，可以根據實際返回陣列或json物件

當status!=0 都應該有錯誤資訊

介面規範 API介面

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

API介面規範

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

API 介面開發規範

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