RESTful api風格介紹

陌上兮月發表於2018-09-20

RESTful 介面是目前來說比較流行的一種介面,平常在開發中會非常常見。

有過和後端人員對接介面的小夥伴都應該知道,我們所做的大多數操作都是對資料庫的四格操作 “增刪改查” 對應到我們的介面操作分別是:

  1. post 插入新資料
  2. delete 刪除資料
  3. put 修改資料
  4. get 查詢資料

注意,這裡是我們約定,並非這些動作只能幹這件事情。從表層來說,除get外的其他方法,沒有什麼區別,都是一樣的。從深層來說包括 get 在內的所有方法都是一模一樣的,沒有任何區別。但是,我們約定,每種動作對應不同的操作,這樣方便我們統一規範我們的所有操作。

假設,我們的介面是 /api/v1/love 這樣的介面,採用 RESTful 介面風格對應操作是如下的:


get 操作 /api/v1/love

獲取 /api/v1/love 的分頁列表資料,得到的主體,將是一個陣列,我們可以用資料來遍歷迴圈列表

post 操作 /api/v1/love

我們會往 /api/v1/love 插入一條新的資料,我們插入的資料,將是JOSN利用物件傳輸的。

get 操作 /api/v1/love/1

我們獲取到一個 ID 為 1 的的資料,資料一般為一個物件,裡面包含了 1 的各項欄位資訊。

put 操作 /api/v1/love/1

我們向介面提交了一個新的資訊,來修改 ID 為 1 的這條資訊

delete 操作 /api/v1/love/1

我們向介面請求,刪除 ID 為 1 的這一條資料


由上述例子可知,我們實現了5種操作,但只用了兩個介面地址, /api/v1/love 和 /api/v1/love/1 。所以,採用這種介面風格,可以大幅的簡化我們的介面設計。

相關文章