SSM 實戰項目①丨圖書管理系統 丨技術儲備丨(2)RESTful API 接口設計總結

RestfulAPI

本篇隸屬於《SSM 實戰項目①丨圖書管理系統 》

詳情請見:SSM 實戰項目①丨圖書管理系統 丨(0) 項目概要及本系列介紹


1. REST

簡而言之,REST 指的是一組架構約束條件和原則。滿足這些約束條件和原則的應用程序或設計就是 RESTful。

2. RESTful 風格

所謂 RESTful 風格其實就是利用客戶端與服務端之前請求方式的不同(如:POST,DELETE,PUT和GET)來區分不同的接口,從而使接口名稱更加簡約、更易擴展。

3. RESTful 風格特點
  • 每一個URI代表1種資源;

  • 客戶端使用GET、POST、PUT、DELETE4個表示操作方式的動詞對服務端資源進行操作:GET用來獲取資源,POST用來新建資源(也可以用於更新資源),PUT用來更新資源,DELETE用來刪除資源;

  • 通過操作資源的表現形式來操作資源;

  • 資源的表現形式是XML或者HTML;

  • 客戶端與服務端之間的交互在請求之間是無狀態的,從客戶端到服務端的每個請求都必須包含理解請求所必需的信息。

4. RESTful API 舉例
  • 單層結構
接口名稱 請求方式 解釋
/emp/{id} GET 根據id查詢員工信息
/emp/{id} PUT 修改id={id}的員工信息
/emp/{id} DELETE 刪除id={id}的員工信息
/emps GET 查詢所有員工信息
/emp POST 新增員工
  • 多層結構
接口名稱 請求方式 解釋
/dept/{deptId}/emp/{id} GET 查詢指定部門的指定員工的信息

參考資料:

RESTful API 設計指南

百度百科:RESTful

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章