Restful介面規約

Restful介面規約

在前後端分離的程式架構下，前後端互動一般是由前端通過HTTP協議訪問後端提供的Restful風格的API進行的。在這種場景下，常用的HTTP方法主要包括：GET、PUT、POST和DELETE。

1. GET

GET方法用於獲取資源詳情或者列表，不對資源做變更。其一般使用場景如下：

1. 獲取某個資源的詳情：/resourceName/{id}，Path Variable中的id即為要獲取的那個資源的唯一id

   特別的，當要獲取當前登入使用者的詳情時，由於後端的Security Context中知道當前使用者是誰，所以一般直接使用：/user 即可。

2. 分頁獲取某種資源列表：/resourceName/list?page=xxx&size=xxx

   page指當前的頁碼，size指每一頁的資源數量，同樣的，可以增加其他Query String引數以實現例如下拉篩選和模糊查詢等功能。

2. PUT

PUT方法用於新增（新增）某個資源。新增的資源資料一般放在RequestBody中提交給後端。

3. POST

POST方法用於對某個資源進行修改（更新）。需要更新的資料一般放在RequestBody中提交給後端。

4. DELETE

DELETE方法用於刪除某個資源。一般用法是：/resourceName/{id}，同樣的，Path Variable中的id即為要刪除的那個資源的唯一id。