出現(xiàn)原因
前后端分離之后客燕,后端負責數據編造舟奠,前端負責數據渲染,前端通過調用指定API獲取統(tǒng)一格式的靜態(tài)數據贴铜,之內的API的設計就成為了一個問題数初,
restful API就是其中一種便于理解肌稻,易于使用的一種api約束。
設計原則
1 客戶端-服務器:通過將用戶UI與數據存儲分開蹲嚣,我們可以簡化服務器組件來提高跨多個平臺的用戶界面的可移植性并提高可伸縮性递瑰。 它可以比表>現(xiàn)成前后端分離的思想祟牲。
2 無狀態(tài):從客戶端到服務器的每個請求都必須包含理解請求所需的所有信息,并且不能利用服務器上任何存儲的上下文抖部。 這表示你應該盡可能的避免使用session疲眷,由客戶端自己標識會話狀態(tài)。(token)
3 規(guī)范接口:REST接口約束定義:資源識別; 請求動作; 響應信息; 它表示通過uri標出你要操作的資源您朽,通過請求動作(http method)標識要執(zhí)行的操作狂丝,通過返回的狀態(tài)碼來表示這次請求的執(zhí)行結果。
4 可緩存: 緩存約束要求將對請求的響應中的數據隱式或顯式標記為可緩存或不可緩存哗总。如果響應是可緩存的几颜,則客戶端緩存有權重用該響應數據以用于以后的等效請求。 它表示get請求響應頭中應該表示有是否可緩存的頭(Cache-Control)
其中1讯屈,2蛋哭,3約束最為重要,其中1容易理解涮母。接下來我們就談談無狀態(tài)和規(guī)范接口的原則谆趾。
鏈接:http://www.reibang.com/p/a35bad7dbc54
URI規(guī)范 (統(tǒng)一資源定位符,URL:統(tǒng)一資源標識符)
uri是具體的資源叛本,而url是具體的資源的地址沪蓬,url是屬于uri的一部分
資源描述構成了URI,其約束一般如下
- 使用名詞。如user来候,student
http://api.example.com/class-management/students
http://api.example.com/user-management/users/
http://api.example.com/user-management/users/{id} - http method對應不同的請求動作(數據庫或業(yè)務)
-
GET---查詢操作
HTTP GET /devices?startIndex=0&size=20
HTTP GET /configurations?startIndex=0&size=20 (url傳參可用跷叉?連接,多個參數用&連接) -
POST---新增操作
HTTP POST /device -
PUT---更新操作
HTTP PUT /devices/{id} -
PATCH---部分更新营搅,由于瀏覽器兼容性問題云挟,更推薦put
HTTP PATCH /devices/{id} - DELETE---刪除操作
- 使用連字符(-)而不是(_)來提高URI的可讀性
http://api.example.com/inventory-management/managed-entities/{id}/install-script-location //更易讀 - 在URI中使用小寫字母
http://api.example.org/my-folder/my-doc - 不推薦使用文件擴展名
http://api.example.com/device-management/managed-devices.xml (錯誤寫法)
http://api.example.com/device-management/managed-devices (正確寫法) - 使用查詢組件過濾URI集合
很多時候需要對數據進行排序,搜索和過濾的操作转质,建議的寫法是將輸入參數作為查詢參數园欣,為不是創(chuàng)建新的API
<meta charset="utf-8">
http://api.example.com/device-management/managed-devices?region=USA
http://api.example.com/device-management/managed-devices?region=USA&brand=XYZ
- 不要在末尾使用/
作為URI路徑中的最后一個字符,正斜杠(/)不會添加語義值休蟹,并可能導致混淆沸枯。最好完全放棄它們。 - 使用http狀態(tài)碼定義api執(zhí)行結果
1xx:信息
通信傳輸協(xié)議級信息鸡挠。
2xx:成功
表示客戶端的請求已成功接受
3xx:重定向
表示客戶端必須執(zhí)行一些其他操作才能完成其請求辉饱。
4xx:客戶端錯誤
此類錯誤狀態(tài)代碼指向客戶端。
5xx:服務器錯誤
服務器負責這些錯誤狀態(tài)代碼拣展。
如前端調用接口經常用到的400彭沼,是客戶端的錯誤,一般是傳參不對或者格式有問題
500 就是服務器錯誤备埃,無法完成請求 - api版本定義
已經有投入使用的api,此時api更新升級,此時可以使用下面的方法
- 版本控制(推薦)
http://api.example.com/v1 - 使用自定義請求標頭進行版本控制
Accept-version:v1
無狀態(tài)
- 無狀態(tài)通過將api部署到多個服務器中,有助于擴展到數百萬并發(fā)用戶蛤奥。(集群)
- 無狀態(tài)使得REST API不那么復雜 - 可以刪除所有服務器端狀態(tài)同步邏輯味抖。(刪除session刷喜,清理多余空間)
- 無狀態(tài)API也很容易緩存。特定軟件可以通過查看該一個請求來決定是否緩存HTTP請求的結果。(易緩存)
- 客戶端會在每個請求中發(fā)送所有必要的信息,如服務器存貯的token等脖旱。(攜帶token)