出現(xiàn)原因
前后端分離之后，后端負(fù)責(zé)數(shù)據(jù)編造，前端負(fù)責(zé)數(shù)據(jù)渲染，前端通過調(diào)用指定API獲取統(tǒng)一格式的靜態(tài)數(shù)據(jù)，之內(nèi)的API的設(shè)計(jì)就成為了一個(gè)問題，
restful API就是其中一種便于理解，易于使用的一種api約束。
設(shè)計(jì)原則
1 客戶端-服務(wù)器：通過將用戶UI與數(shù)據(jù)存儲(chǔ)分開，我們可以簡(jiǎn)化服務(wù)器組件來提高跨多個(gè)平臺(tái)的用戶界面的可移植性并提高可伸縮性。 它可以比表>現(xiàn)成前后端分離的思想。
2 無狀態(tài)：從客戶端到服務(wù)器的每個(gè)請(qǐng)求都必須包含理解請(qǐng)求所需的所有信息，并且不能利用服務(wù)器上任何存儲(chǔ)的上下文。 這表示你應(yīng)該盡可能的避免使用session，由客戶端自己標(biāo)識(shí)會(huì)話狀態(tài)。（token）
3 規(guī)范接口：REST接口約束定義：資源識(shí)別; 請(qǐng)求動(dòng)作; 響應(yīng)信息; 它表示通過uri標(biāo)出你要操作的資源，通過請(qǐng)求動(dòng)作（http method）標(biāo)識(shí)要執(zhí)行的操作，通過返回的狀態(tài)碼來表示這次請(qǐng)求的執(zhí)行結(jié)果。
4 可緩存： 緩存約束要求將對(duì)請(qǐng)求的響應(yīng)中的數(shù)據(jù)隱式或顯式標(biāo)記為可緩存或不可緩存。如果響應(yīng)是可緩存的，則客戶端緩存有權(quán)重用該響應(yīng)數(shù)據(jù)以用于以后的等效請(qǐng)求。 它表示get請(qǐng)求響應(yīng)頭中應(yīng)該表示有是否可緩存的頭（Cache-Control)
其中1，2，3約束最為重要，其中1容易理解。接下來我們就談?wù)劅o狀態(tài)和規(guī)范接口的原則。
鏈接：http://www.itdecent.cn/p/a35bad7dbc54
URI規(guī)范 （統(tǒng)一資源定位符，URL：統(tǒng)一資源標(biāo)識(shí)符）
uri是具體的資源，而url是具體的資源的地址，url是屬于uri的一部分
資源描述構(gòu)成了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對(duì)應(yīng)不同的請(qǐng)求動(dòng)作（數(shù)據(jù)庫(kù)或業(yè)務(wù))
-
GET---查詢操作
HTTP GET /devices?startIndex=0&size=20
HTTP GET /configurations?startIndex=0&size=20 （url傳參可用？連接，多個(gè)參數(shù)用&連接） -
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 - 不推薦使用文件擴(kuò)展名
http://api.example.com/device-management/managed-devices.xml （錯(cuò)誤寫法）
http://api.example.com/device-management/managed-devices （正確寫法） - 使用查詢組件過濾URI集合
很多時(shí)候需要對(duì)數(shù)據(jù)進(jìn)行排序，搜索和過濾的操作，建議的寫法是將輸入?yún)?shù)作為查詢參數(shù)，為不是創(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路徑中的最后一個(gè)字符，正斜杠（/）不會(huì)添加語義值，并可能導(dǎo)致混淆。最好完全放棄它們。 - 使用http狀態(tài)碼定義api執(zhí)行結(jié)果
1xx：信息
通信傳輸協(xié)議級(jí)信息。
2xx：成功
表示客戶端的請(qǐng)求已成功接受
3xx：重定向
表示客戶端必須執(zhí)行一些其他操作才能完成其請(qǐng)求。
4xx：客戶端錯(cuò)誤
此類錯(cuò)誤狀態(tài)代碼指向客戶端。
5xx：服務(wù)器錯(cuò)誤
服務(wù)器負(fù)責(zé)這些錯(cuò)誤狀態(tài)代碼。
如前端調(diào)用接口經(jīng)常用到的400，是客戶端的錯(cuò)誤，一般是傳參不對(duì)或者格式有問題
500 就是服務(wù)器錯(cuò)誤，無法完成請(qǐng)求 - api版本定義
已經(jīng)有投入使用的api,此時(shí)api更新升級(jí)，此時(shí)可以使用下面的方法
- 版本控制(推薦）
http://api.example.com/v1 - 使用自定義請(qǐng)求標(biāo)頭進(jìn)行版本控制
Accept-version：v1
無狀態(tài)
- 無狀態(tài)通過將api部署到多個(gè)服務(wù)器中，有助于擴(kuò)展到數(shù)百萬并發(fā)用戶。（集群）
- 無狀態(tài)使得REST API不那么復(fù)雜 - 可以刪除所有服務(wù)器端狀態(tài)同步邏輯。（刪除session，清理多余空間）
- 無狀態(tài)API也很容易緩存。特定軟件可以通過查看該一個(gè)請(qǐng)求來決定是否緩存HTTP請(qǐng)求的結(jié)果。（易緩存）
- 客戶端會(huì)在每個(gè)請(qǐng)求中發(fā)送所有必要的信息，如服務(wù)器存貯的token等。（攜帶token）
部分信息轉(zhuǎn)載至http://www.itdecent.cn/p/a35bad7dbc54
