RESTful架構(gòu)和RESTful?API設(shè)計(jì)總結(jié)

時(shí)間：2021-08-13 17:07:59

關(guān)鍵字： RESTful API Resource

手機(jī)看文章

掃描二維碼
隨時(shí)隨地手機(jī)看文章

[導(dǎo)讀]REST這個(gè)詞是2000年RoyFielding在他的博士論文中提出的，F(xiàn)ielding參與了http協(xié)議的設(shè)計(jì)，也是Apachewebserver項(xiàng)目的參與者。他的這篇博士論文可以說(shuō)對(duì)互聯(lián)網(wǎng)的軟件設(shè)計(jì)產(chǎn)生了深遠(yuǎn)的影響。但是從字面上理解REST(RepresentationalS...

REST這個(gè)詞是2000年Roy Fielding在他的博士論文中提出的，F(xiàn)ielding參與了http協(xié)議的設(shè)計(jì)，也是Apache web server項(xiàng)目的參與者。他的這篇博士論文可以說(shuō)對(duì)互聯(lián)網(wǎng)的軟件設(shè)計(jì)產(chǎn)生了深遠(yuǎn)的影響。但是從字面上理解REST(Representational State Transfer, 表現(xiàn)層狀態(tài)轉(zhuǎn)移)是非常抽象的。因此，本篇文章試圖將REST進(jìn)行拆解，分別從以下幾個(gè)部分來(lái)進(jìn)行解讀：

Resource 資源
REST忽略了主語(yǔ)，全稱應(yīng)該是資源的表現(xiàn)層狀態(tài)轉(zhuǎn)移。所謂資源就是互聯(lián)網(wǎng)上的各種資源，比如文本、圖片、音頻、視頻等。在互聯(lián)網(wǎng)上通過(guò)URI指定唯一的資源，所謂的’上網(wǎng)‘就是通過(guò)調(diào)用資源的URL來(lái)跟互聯(lián)網(wǎng)上的一系列資源進(jìn)行互動(dòng)。
注：URI只代表資源的實(shí)體，嚴(yán)格地說(shuō)，有些網(wǎng)址最后的.html后綴名是不必要的，因?yàn)檫@個(gè)后綴名表示格式，屬于"表現(xiàn)層"范疇，而URI應(yīng)該只代表"資源"的位置。
Representational 表象
資源可以有各種具體的表現(xiàn)形式，比如文本可以有xml格式，html格式，json格式，甚至是二進(jìn)制格式，圖片可以有PNG格式，JPEG格式等。資源的一個(gè)具體表現(xiàn)形式，應(yīng)該在HTTP請(qǐng)求的頭信息中用Accept和Content-Type字段指定，這兩個(gè)字段才是對(duì)"表現(xiàn)層"的描述。
State Transfer 狀態(tài)轉(zhuǎn)移
通過(guò)http動(dòng)詞來(lái)實(shí)現(xiàn)資源的狀態(tài)轉(zhuǎn)移，用GET來(lái)請(qǐng)求資源，用POST來(lái)新建資源，用PUT來(lái)更新資源，用DELETE來(lái)刪除資源。
簡(jiǎn)明扼要的總結(jié)REST：

用URI來(lái)定位具體的資源
用HTTP請(qǐng)求的Content-Type字段來(lái)描述資源的表現(xiàn)形式
用HTTP動(dòng)詞來(lái)描述對(duì)資源的具體操作

RESTful API設(shè)計(jì)總結(jié)

隨著近年來(lái)移動(dòng)互聯(lián)網(wǎng)的發(fā)展，各種客戶端出不窮：Web，IOS，Android。因此需要一種機(jī)制使得各種客戶端能夠和服務(wù)端進(jìn)行通訊，這就使得RESTful API的架構(gòu)流行起來(lái)。RESTful是REST(表現(xiàn)層狀態(tài)轉(zhuǎn)化)的形容詞形式，因此RESTful API就可以理解成“符合REST風(fēng)格的API”。

格式規(guī)范

根據(jù)RFC3986定義，URL是大小寫(xiě)敏感的。所以為了避免歧義，盡量使用小寫(xiě)字母。
RESTful API 應(yīng)具備良好的可讀性，當(dāng)url中某一個(gè)片段（segment）由多個(gè)單詞組成時(shí)，建議使用-來(lái)隔斷單詞，而不是使用_。這主要是因?yàn)?，瀏覽器中超鏈接顯示的默認(rèn)效果是文字并附帶下劃線，如果API以_隔斷單詞，二者會(huì)重疊，影響可讀性。
/api/featured-post/ # GOOD
/api/featured_post/ # WRONG

協(xié)議

提供給用戶的API，總是使用HTTPs協(xié)議。使用HTTPs協(xié)議還是HTTP協(xié)議本身和RESTful API并無(wú)關(guān)系，但是這對(duì)于提高網(wǎng)站的安全性很重要。

域名

API應(yīng)該放在專有域名下，比如https://api.example.com/v1。也可以簡(jiǎn)單地把版本放在URL中，比如https://www.example.com/api/v1

版本

API的版本號(hào)應(yīng)該放在URL中：
https://api.example.com/v1/

名詞應(yīng)該使用復(fù)數(shù)

所用的名詞往往和數(shù)據(jù)庫(kù)的表名對(duì)應(yīng)，而數(shù)據(jù)庫(kù)的表是一組記錄的集合，因此URL中的名詞即表示一組資源的集合，故URI中的名詞要使用復(fù)數(shù)
https://api.example.com/v1/students
https://api.example.com/v1/schools
https://api.example.com/v1/employees