轉(zhuǎn)載自：https://jsbintask.cn/2019/03/20/api/restful-api-best-practices/
rest = representational state transfer三個(gè)單詞的縮寫
1竭贩、rest設(shè)計(jì)規(guī)則：
1、前后端分離的思想
2、從客戶端到服務(wù)器的每個(gè)請(qǐng)求都必須包含理解請(qǐng)求所需的所有信息，并且不能利用服務(wù)器上任何存儲(chǔ)的上下文。
3比驻、REST接口約束定義：
????資源識(shí)別; 請(qǐng)求動(dòng)作; 響應(yīng)信息; 它表示通過(guò)uri標(biāo)出你要操作的資源，通過(guò)請(qǐng)求動(dòng)作（http method）標(biāo)識(shí)要執(zhí)行的操作，通過(guò)返回的狀態(tài)碼來(lái)表示這次請(qǐng)求的執(zhí)行結(jié)果稚茅。
2、uri規(guī)范：
1平斩、使用名詞亚享，如http://api.example.com/class-management/students
2、http method對(duì)應(yīng)不同的請(qǐng)求動(dòng)作（數(shù)據(jù)庫(kù)或者業(yè)務(wù)邏輯）
GET：查詢操作：
HTTP GET /devices?startIndex=0&size=20
POST：新增操作：
HTTP POST /device
PUT?更新操作（代表更新一個(gè)實(shí)體的所有屬性）
HTTP PUT /devices/{id}
PATCH?部分更新（代表更新一個(gè)尸體的部分屬性）由于有的瀏覽器兼容性問(wèn)題绘面，一般推薦使用put
HTTP PATCH /devices/{id}
DELETE?刪除操作
HTTP DELETE /devices/{id}
3欺税、用連字符（ - ）而不是（_）來(lái)提高URI的可讀性
http://api.example.com/inventory-management/managed-entities/{id}/install-script-location?//更易讀
http://api.example.com/inventory_management/managed_entities/{id}/install_script_location?//更容易出錯(cuò)
4、URI中使用小寫字母
http://api.example.org/my-folder/my-doc
5揭璃、不要使用文件擴(kuò)展名 文件擴(kuò)展名看起來(lái)很糟糕晚凿，不會(huì)增加任何優(yōu)勢(shì)。刪除它們也會(huì)減少URI的長(zhǎng)度瘦馍。沒(méi)理由保留它們歼秽。
http://api.example.com/device-management/managed-devices.xml?/?不要使用它?/
http://api.example.com/device-management/managed-devices?/?這是正確的URI?/
6、使用查詢組件過(guò)濾URI集合
很多時(shí)候情组，我們會(huì)遇到需要根據(jù)某些特定資源屬性對(duì)需要排序燥筷，過(guò)濾或限制的資源集合的要求箩祥。為此，請(qǐng)不要?jiǎng)?chuàng)建新的API - 而是在資源集合API中啟用排序肆氓，過(guò)濾和分頁(yè)功能袍祖，并將輸入?yún)?shù)作為查詢參數(shù)傳遞。例如
http://api.example.com/device-management/managed-devices
http://api.example.com/device-management/managed-devices?region=USA
http://api.example.com/device-management/managed-devices?region=USA&brand=XYZ
http://api.example.com/device-management/managed-devices?region=USA&brand=XYZ&sort=installation-date
7做院、不要在末尾使用/
作為URI路徑中的最后一個(gè)字符盲泛，正斜杠（/）不會(huì)添加語(yǔ)義值，并可能導(dǎo)致混淆键耕。最好完全放棄它們寺滚。
8、api版本定義
當(dāng)我們需要對(duì)現(xiàn)有的api接口升級(jí)的時(shí)候屈雄，因?yàn)樵揳pi接口已經(jīng)投入使用村视，所以新添加的業(yè)務(wù)可能無(wú)法保證兼容原來(lái)的邏輯，這個(gè)時(shí)候就需要新的接口酒奶，而這個(gè)接口一般表示對(duì)原來(lái)的接口的升級(jí)（不同版本）蚁孔，那版本怎么定義呢？
URI版本控制（推薦）
使用自定義請(qǐng)求標(biāo)頭進(jìn)行版本控制
Accept-version：v1
Accept-version：v2
使用Accept header 進(jìn)行版本控制
Accept:application / vnd.example.v1 + json
Accept:application / vnd.example + json; version = 1.0
總結(jié)：
1惋嚎、HTTP動(dòng)詞
常用的HTTP動(dòng)詞有下面五個(gè)
GET（SELECT）：從服務(wù)器取出資源（一項(xiàng)或多項(xiàng)）杠氢。
POST（CREATE）：在服務(wù)器新建一個(gè)資源。
PUT（UPDATE）：在服務(wù)器更新資源（客戶端提供改變后的完整資源）另伍。
PATCH（UPDATE）：在服務(wù)器更新資源（客戶端提供改變的屬性）鼻百。
DELETE（DELETE）：從服務(wù)器刪除資源
2、RESTful架構(gòu)
服務(wù)器上每一種資源摆尝，比如一個(gè)文件温艇，一張圖片，一部電影堕汞，都有對(duì)應(yīng)的url地址勺爱，如果我們的客戶端需要對(duì)服務(wù)器上的這個(gè)資源進(jìn)行操作，就需要通過(guò)http協(xié)議執(zhí)行相應(yīng)的動(dòng)作來(lái)操作它讯检，比如進(jìn)行獲取琐鲁，更新，刪除人灼。
簡(jiǎn)單來(lái)說(shuō)就是url地址中只包含名詞表示資源绣否，使用http動(dòng)詞表示動(dòng)作進(jìn)行操作資源
舉個(gè)例子：左邊是錯(cuò)誤的設(shè)計(jì)，而右邊是正確的
GET/blog/getArticles-->GET/blog/Articles? ? ?獲取所有文章
GET/blog/addArticles-->POST/blog/Articles? 添加一篇文章
GET/blog/editArticles-->PUT/blog/Articles? ? ?修改一篇文章?
GET/rest/api/deleteArticles?id=1-->DELETE/blog/Articles/1 刪除一篇文章
此處轉(zhuǎn)載于鏈接：http://www.reibang.com/p/6baf8554b3f4
3挡毅、怎么用RESTful
一、每個(gè)資源使用2個(gè)URL暴构，網(wǎng)址中只能有名詞
二跪呈、對(duì)于資源的操作類型由HTTP動(dòng)詞來(lái)表示
三段磨、統(tǒng)一的返回結(jié)果
四、返回正確的狀態(tài)碼
五耗绿、允許通過(guò)HTTP內(nèi)容協(xié)商苹支，建議格式預(yù)定義為JSON
六、對(duì)可選發(fā)雜的參數(shù)误阻，使用查詢字符串（债蜜？）
七、返回有用的錯(cuò)誤信息(message)
八究反、非資源請(qǐng)求用動(dòng)詞寻定，這看起似乎和1中的說(shuō)法有矛盾，但這里指的是非資源精耐，而不是資源
鏈接：http://www.reibang.com/p/0e7e379afc6f
