介紹

現(xiàn)在的網(wǎng)絡(luò)應(yīng)用程序，分為前端和后端兩個(gè)部分锥惋， 采用客戶端/服務(wù)器 模式昌腰。

后端建立在分布式體系上，通過互聯(lián)網(wǎng)通信膀跌，具有高延時(shí)（high latency）遭商、高并發(fā)等特點(diǎn)；前端設(shè)備層出不窮（如手機(jī)淹父、平板株婴、桌面電腦、其他專用設(shè)備......）暑认。

each client app has its own embedded business logic

因此困介，必須有一種統(tǒng)一的機(jī)制，方便不同的前端設(shè)備與后端進(jìn)行通信蘸际。這導(dǎo)致API構(gòu)架的流行座哩，甚至出現(xiàn)"API First"的設(shè)計(jì)思想。

central API which hold all the business logic

目前粮彤，有三種主流的Web服務(wù)交互方案：

• SOAP（Simple Object Access protocol根穷，簡單對(duì)象訪問協(xié)議）
• XML-RPC
• RESTful姜骡。

RESTful架構(gòu)，是目前最流行的一種互聯(lián)網(wǎng)軟件架構(gòu)屿良。它結(jié)構(gòu)清晰圈澈、符合標(biāo)準(zhǔn)、易于理解尘惧、擴(kuò)展方便康栈。RESTful API是目前比較成熟的一套互聯(lián)網(wǎng)應(yīng)用程序的API設(shè)計(jì)理論。

概念簡述

REST（Representational State Transfer）這個(gè)詞喷橙，是Roy Thomas Fielding在他2000年的博士論文中提出的啥么。

Fielding是HTTP協(xié)議（1.0版和1.1版）的主要設(shè)計(jì)者、Apache服務(wù)器軟件的作者之一贰逾、Apache基金會(huì)的第一任主席悬荣。

他寫的關(guān)于RESTful的論文是這樣描述的：

"本文研究計(jì)算機(jī)科學(xué)兩大前沿----軟件和網(wǎng)絡(luò)----的交叉點(diǎn)。長期以來疙剑，軟件研究主要關(guān)注軟件設(shè)計(jì)的分類氯迂、設(shè)計(jì)方法的演化，很少客觀地評(píng)估不同的設(shè)計(jì)選擇對(duì)系統(tǒng)行為的影響言缤。而相反地囚戚，網(wǎng)絡(luò)研究主要關(guān)注系統(tǒng)之間通信行為的細(xì)節(jié)、如何改進(jìn)特定通信機(jī)制的表現(xiàn)轧简，常常忽視了一個(gè)事實(shí)，那就是改變應(yīng)用程序的互動(dòng)風(fēng)格比改變互動(dòng)協(xié)議匾二，對(duì)整體表現(xiàn)有更大的影響哮独。我這篇文章的寫作目的，就是想在符合架構(gòu)原理的前提下察藐，理解和評(píng)估以網(wǎng)絡(luò)為基礎(chǔ)的應(yīng)用軟件的架構(gòu)設(shè)計(jì)皮璧，得到一個(gè)功能強(qiáng)、性能好分飞、適宜通信的架構(gòu)悴务。"

Fielding將他對(duì)互聯(lián)網(wǎng)軟件的架構(gòu)原則，定名為REST譬猫，即Representational State Transfer的縮寫讯檐，翻譯為"表現(xiàn)層狀態(tài)轉(zhuǎn)化"。

如果一個(gè)架構(gòu)符合REST原則染服，就稱它為RESTful架構(gòu)别洪。

主要的原則：

• 資源（Resources）
  REST的名稱"表現(xiàn)層狀態(tài)轉(zhuǎn)化"中，省略了主語柳刮。"表現(xiàn)層"其實(shí)指的是"資源"（Resources）的"表現(xiàn)層"挖垛。
  所謂"資源"痒钝，就是網(wǎng)絡(luò)上的一個(gè)實(shí)體，或者說是網(wǎng)絡(luò)上的一個(gè)具體信息痢毒。它可以是一段文本送矩、一張圖片、一首歌曲哪替、一種服務(wù)栋荸，總之就是一個(gè)具體的實(shí)在。你可以用一個(gè)URI（統(tǒng)一資源定位符）指向它夷家，每種資源對(duì)應(yīng)一個(gè)特定的URI蒸其。要獲取這個(gè)資源，訪問它的URI就可以库快，因此URI就成了每一個(gè)資源的地址或獨(dú)一無二的識(shí)別符摸袁。

• 無狀態(tài)性
  客戶端和服務(wù)器之間的交互在請求之間是無狀態(tài)的。
  從客戶端到服務(wù)器的每個(gè)請求都必須包含理解請求所必需的信息义屏。如果服務(wù)器在請求之間的任何時(shí)間點(diǎn)重啟靠汁，客戶端不會(huì)得到通知。此外闽铐，無狀態(tài)請求可以由任何可用服務(wù)器回答蝶怔，這十分適合云計(jì)算之類的環(huán)境⌒质客戶端可以緩存數(shù)據(jù)以改進(jìn)性能踢星。

• 統(tǒng)一接口
  所有資源都共享統(tǒng)一的界面，以便在客戶端和服務(wù)器之間傳輸狀態(tài)隙咸。
  使用的是標(biāo)準(zhǔn)的 HTTP 方法沐悦，使用 GET、PUT五督、POST 和 DELETE等藏否。Hypermedia 是應(yīng)用程序狀態(tài)的引擎，資源表示通過超鏈接互聯(lián)充包。

• 表現(xiàn)層（Representation）
  "資源"是一種信息實(shí)體副签，它可以有多種外在表現(xiàn)形式。我們把"資源"具體呈現(xiàn)出來的形式基矮，叫做它的"表現(xiàn)層"（Representation）淆储。
  例如：文本可以用txt格式表現(xiàn)，也可以用HTML格式愈捅、XML格式遏考、JSON格式表現(xiàn)，甚至可以采用二進(jìn)制格式蓝谨；圖片可以用JPG格式表現(xiàn)灌具，也可以用PNG格式表現(xiàn)青团。
  URI應(yīng)該只代表"資源"的位置，它的具體表現(xiàn)形式咖楣，在HTTP請求的頭信息中用Accept和Content-Type字段指定督笆，這兩個(gè)字段才是對(duì)"表現(xiàn)層"的描述。

• 分層系統(tǒng)
  組件無法了解它與之交互的中間層以外的組件诱贿。通過將系統(tǒng)知識(shí)限制在單個(gè)層娃肿，可以限制整個(gè)系統(tǒng)的復(fù)雜性，促進(jìn)了底層的獨(dú)立性珠十。

• 狀態(tài)轉(zhuǎn)化（State Transfer）
  訪問一個(gè)網(wǎng)站料扰，就代表了客戶端和服務(wù)器的一個(gè)互動(dòng)過程。在這個(gè)過程中焙蹭，勢必涉及到數(shù)據(jù)和狀態(tài)的變化晒杈。
  互聯(lián)網(wǎng)通信協(xié)議HTTP協(xié)議，是一個(gè)無狀態(tài)協(xié)議孔厉。這意味著拯钻，所有的狀態(tài)都保存在服務(wù)器端。因此撰豺，如果客戶端想要操作服務(wù)器粪般，必須通過某種手段，讓服務(wù)器端發(fā)生"狀態(tài)轉(zhuǎn)化"（State Transfer）污桦。而這種轉(zhuǎn)化是建立在表現(xiàn)層之上的亩歹，所以就是"表現(xiàn)層狀態(tài)轉(zhuǎn)化"。

簡單總結(jié)

什么是RESTful架構(gòu)：

1. 每一個(gè)URI代表一種資源凡橱；
2. 客戶端和服務(wù)器之間捆憎，傳遞這種資源的某種表現(xiàn)層；
3. 客戶端通過四個(gè)HTTP動(dòng)詞梭纹，對(duì)服務(wù)器端資源進(jìn)行操作，實(shí)現(xiàn)"表現(xiàn)層狀態(tài)轉(zhuǎn)化"致份。

誤區(qū)

• URI包含動(dòng)詞变抽。
  "資源"表示一種實(shí)體，所以應(yīng)該是名詞氮块，URI不應(yīng)該有動(dòng)詞绍载，動(dòng)詞應(yīng)該放在HTTP協(xié)議中。
  舉例來說滔蝉，某個(gè)URI是/posts/show/1击儡，其中show是動(dòng)詞，這個(gè)URI就設(shè)計(jì)錯(cuò)了蝠引，正確的寫法應(yīng)該是/posts/1阳谍，然后用GET方法表示show蛀柴。
  如果某些動(dòng)作是HTTP動(dòng)詞表示不了的，你就應(yīng)該把動(dòng)作做成一種資源矫夯。比如網(wǎng)上匯款鸽疾，從賬戶1向賬戶2匯款500元，錯(cuò)誤的URI是：

    POST /accounts/1/transfer/500/to/2
  

正確的寫法是把動(dòng)詞transfer改成名詞transaction训貌，資源不能是動(dòng)詞制肮，但 是可以是一種服務(wù)：
POST /transaction HTTP/1.1
Host: 127.0.0.1
from=1&to=2&amount=500.00

RESTful API

1. 協(xié)議

   API與用戶的通信協(xié)議，總是使用HTTPs協(xié)議(SSL/TLS)递沪。

2. 域名

   應(yīng)該盡量將API部署在專用域名之下豺鼻。
   https://api.example.com

   如果確定API很簡單，不會(huì)有進(jìn)一步擴(kuò)展款慨，可以考慮放在主域名下儒飒。

    https://example.org/api/
   

3. 版本（Versioning）：

   • 將API的版本號(hào)放入U(xiǎn)RL。

      https://api.example.com/v1/
     

• 將版本號(hào)放在HTTP頭信息中樱调，但不如放入U(xiǎn)RL方便和直觀约素。Github采用這種做法。
  Accept: vnd.example-com.foo+json; version=1.0

4. 路徑（Endpoint）

路徑又稱"終點(diǎn)"（endpoint）笆凌，表示API的具體網(wǎng)址圣猎。

在RESTful架構(gòu)中，每個(gè)網(wǎng)址代表一種資源（resource）乞而，所以網(wǎng)址中不能有動(dòng)詞送悔，只能有名詞，而且所用的名詞往往與數(shù)據(jù)庫的表格名對(duì)應(yīng)爪模。一般來說欠啤，數(shù)據(jù)庫中的表都是同種記錄的"集合"（collection），所以API中的名詞也應(yīng)該使用復(fù)數(shù)屋灌。

舉例來說洁段，有一個(gè)API提供動(dòng)物園（zoo）的信息，還包括各種動(dòng)物和雇員的信息共郭，則它的路徑應(yīng)該設(shè)計(jì)成下面這樣祠丝。

    https://api.example.com/v1/zoos
    https://api.example.com/v1/animals
    https://api.example.com/v1/employees

5. HTTP動(dòng)詞

對(duì)于資源的具體操作類型，由HTTP動(dòng)詞表示除嘹。

常用的HTTP動(dòng)詞有下面五個(gè)（括號(hào)里是對(duì)應(yīng)的SQL命令）写半。

• GET（SELECT）：從服務(wù)器取出資源（一項(xiàng)或多項(xiàng)）。
• POST（CREATE）：在服務(wù)器新建一個(gè)資源叠蝇。
• PUT（UPDATE）：在服務(wù)器更新資源（客戶端提供改變后的完整資源）。
• PATCH（UPDATE）：在服務(wù)器更新資源（客戶端提供改變的屬性）悔捶。
• DELETE（DELETE）：從服務(wù)器刪除資源铃慷。

還有兩個(gè)不常用的HTTP動(dòng)詞枚冗。

• HEAD：獲取資源的元數(shù)據(jù)。
• OPTIONS：獲取信息蛇损，關(guān)于資源的哪些屬性是客戶端可以改變的赁温。

下面是一些例子。

    GET /zoos：列出所有動(dòng)物園
    POST /zoos：新建一個(gè)動(dòng)物園
    GET /zoos/ID：獲取某個(gè)指定動(dòng)物園的信息
    PUT /zoos/ID：更新某個(gè)指定動(dòng)物園的信息（提供該動(dòng)物園的全部信息）
    PATCH /zoos/ID：更新某個(gè)指定動(dòng)物園的信息（提供該動(dòng)物園的部分信息）
    DELETE /zoos/ID：刪除某個(gè)動(dòng)物園
    GET /zoos/ID/animals：列出某個(gè)指定動(dòng)物園的所有動(dòng)物
    DELETE /zoos/ID/animals/ID：刪除某個(gè)指定動(dòng)物園的指定動(dòng)物

6. 過濾信息（Filtering）

如果記錄數(shù)量很多淤齐，服務(wù)器不可能都將它們返回給用戶股囊。API應(yīng)該提供參數(shù)，過濾返回結(jié)果更啄。

下面是一些常見的參數(shù)稚疹。

    ?limit=10：指定返回記錄的數(shù)量
    ?offset=10：指定返回記錄的開始位置。
    ?page=2&per_page=100：指定第幾頁祭务，以及每頁的記錄數(shù)内狗。
    ?sortby=name&order=asc：指定返回結(jié)果按照哪個(gè)屬性排序，以及排序順序义锥。
    ?animal_type_id=1：指定篩選條件

參數(shù)的設(shè)計(jì)允許存在冗余柳沙，即允許API路徑和URL參數(shù)偶爾有重復(fù)。比如拌倍，GET /zoo/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的赂鲤。

7. 狀態(tài)碼（Status Codes）

服務(wù)器向用戶返回的狀態(tài)碼和提示信息，常見的有以下一些（方括號(hào)中是該狀態(tài)碼對(duì)應(yīng)的HTTP動(dòng)詞）柱恤。

• 200 OK - [GET]：服務(wù)器成功返回用戶請求的數(shù)據(jù)数初，該操作是冪等的（Idempotent）。
• 201 CREATED - [POST/PUT/PATCH]：用戶新建或修改數(shù)據(jù)成功梗顺。
• 202 Accepted - [*]：表示一個(gè)請求已經(jīng)進(jìn)入后臺(tái)排隊(duì)（異步任務(wù)）
• 204 NO CONTENT - [DELETE]：用戶刪除數(shù)據(jù)成功泡孩。
• 400 INVALID REQUEST - [POST/PUT/PATCH]：用戶發(fā)出的請求有錯(cuò)誤，服務(wù)器沒有進(jìn)行新建或修改數(shù)據(jù)的操作寺谤，該操作是冪等的珍德。
• 401 Unauthorized - [*]：表示用戶沒有權(quán)限（令牌、用戶名矗漾、密碼錯(cuò)誤）。
• 403 Forbidden - [*] 表示用戶得到授權(quán)（與401錯(cuò)誤相對(duì)）薄料，但是訪問是被禁止的敞贡。
• 404 NOT FOUND - [*]：用戶發(fā)出的請求針對(duì)的是不存在的記錄，服務(wù)器沒有進(jìn)行操作摄职，該操作是冪等的誊役。
• 406 Not Acceptable - [GET]：用戶請求的格式不可得（比如用戶請求JSON格式获列，但是只有XML格式）。
• 410 Gone -[GET]：用戶請求的資源被永久刪除蛔垢，且不會(huì)再得到的击孩。
• 422 Unprocesable entity - [POST/PUT/PATCH] 當(dāng)創(chuàng)建一個(gè)對(duì)象時(shí)鹏漆，發(fā)生一個(gè)驗(yàn)證錯(cuò)誤。
• 500 INTERNAL SERVER ERROR - [*]：服務(wù)器發(fā)生錯(cuò)誤括蝠，用戶將無法判斷發(fā)出的請求是否成功忌警。

8. 錯(cuò)誤處理（Error handling）

如果狀態(tài)碼是4xx法绵，就應(yīng)該向用戶返回出錯(cuò)信息朋譬。一般來說婆跑，返回的信息中將error作為鍵名，出錯(cuò)信息作為鍵值即可犀忱。
{
error: "Invalid API key"
}

9. 返回結(jié)果

針對(duì)不同操作阴汇，服務(wù)器向用戶返回的結(jié)果應(yīng)該符合以下規(guī)范搀庶。

• GET /collection：返回資源對(duì)象的列表（數(shù)組）
• GET /collection/resource：返回單個(gè)資源對(duì)象
• POST /collection：返回新生成的資源對(duì)象
• PUT /collection/resource：返回完整的資源對(duì)象
• PATCH /collection/resource：返回完整的資源對(duì)象
• DELETE /collection/resource：返回一個(gè)空文檔

10. Hypermedia API

RESTful API最好做到Hypermedia铜异，即返回結(jié)果中提供鏈接揍庄，連向其他API方法，使得用戶不查文檔沃测，也知道下一步應(yīng)該做什么蒂破。

比如，當(dāng)用戶向api.example.com的根目錄發(fā)出請求惧互，會(huì)得到這樣一個(gè)文檔挟秤。

      {"link": {
          "rel":   "collection https://www.example.com/zoos",
          " href":  "https://api.example.com/zoos",
          "title": "List of zoos",
          "type":  "application/vnd.yourformat+json"
      }}

上面代碼表示管宵，文檔中有一個(gè)link屬性攀甚，用戶讀取這個(gè)屬性就知道下一步該 調(diào)用什么API了。
rel表示這個(gè)API與當(dāng)前網(wǎng)址的關(guān)系（collection關(guān)系炸庞，并給出該collection的網(wǎng)址）埠居。
href表示API的路徑滥壕，title表示API的標(biāo)題兽泣，type表示返回類型唠倦。

Hypermedia API的設(shè)計(jì)被稱為HATEOAS稠鼻。Github的API就是這種設(shè)計(jì)，訪問api.github.com會(huì)得到一個(gè)所有可用API的網(wǎng)址列表熙暴。

     {
        "current_user_url": "https://api.github.com/user",
        "authorizations_url":"https://api.github.com/authorizations",
        // ...
     }

從上面可以看到，如果想獲取當(dāng)前用戶的信息，應(yīng)該去訪問api.github.com/user诗眨，然后就得到了下面結(jié)果匠楚。
{
"message": "Requires authentication",
"documentation_url": "https://developer.github.com/v3"
}

上面代碼表示厂财，服務(wù)器給出了提示信息璃饱，以及文檔的網(wǎng)址荚恶。

11. 其他

• API的身份認(rèn)證應(yīng)該使用OAuth 2.0框架。
• 服務(wù)器返回的數(shù)據(jù)格式食寡，應(yīng)該盡量使用JSON抵皱，避免使用XML辩蛋。

參考資料：

• RESTful API 設(shè)計(jì)指南
• Principles of good RESTful API Design
• Hypertext Transfer Protocol -- HTTP/1.1