我覺得學習一個技術，其實就是要弄明白三件事情：是什麼（what），為什麼（why），怎麼用（how）。正是所謂的三W方法。所以打算總結一個“三問”系列。為了自己學習，也分享給別人。 RESTful是什麼？ REST是REpresentational State Transfer的縮寫。但是repr ...

我覺得學習一個技術，其實就是要弄明白三件事情：是什麼（what），為什麼（why），怎麼用（how）。正是所謂的三W方法。

所以打算總結一個“三問”系列。為了自己學習，也分享給別人。

RESTful是什麼？

REST是REpresentational State Transfer的縮寫。但是representational state transfer仍然很難理解。直譯的話一般譯作表述性狀態轉移。什麼鬼？其實是因為前面主語被去掉了，應該是Resource Representational State Transfer。直譯的話，我覺得可以譯作“具象化的資源狀態轉換”。這隻是我的個人理解。因為這個本來就是老外的晦澀難懂的論文中的辭彙，並沒有一個準確的翻譯。那麼什麼是具象化的資源狀態轉換呢？
Resource：資源，即數據。網路上的所以數據都可以被看做是資源，並且能用一個唯一的URL表示。比如一條用戶信息數據，一張圖片，一個文件等等；
Representational：具象化的。有人認為這個詞是某種表現形式，比如用JSON，XML，JPEG等來表示資源。我覺得理解成具象化的可能更好一點，就是指HTTP中的具體動詞方法：GET，POST，PUT，PATCH，DELETE等等；
State Transfer：狀態轉換。transfer一般是翻譯成轉移，但是我覺得叫“轉換”在這裡更貼切。狀態轉換就是指資源被改變，比如更新操作，刪除操作。其實我也覺得這樣翻譯挺牽強的，什麼嘛還狀態轉換。。。總的來說就是對於網路上的、通過URL表示的資源，我們通過具象化的HTTP方法GET、POST、DELETE等等來操作，改變資源的狀態。
如果你還是沒看懂（應該是沒有），那可以自行參考大神Roy Fielding的畢業論文。REST就是他提出的。這哥們參與設計HTTP協議，也是Apache Web Server項目的co-founder。
論文地址：Architectural Styles and the Design of Network-based Software Architectures
REST章節：Fielding Dissertation: CHAPTER 5: Representational State Transfer (REST) 怎麼樣，看完是不是更懵了呢？沒關係，一句話理解就是：在HTTP請求中，用URL定位資源，用HTTP動詞（GET,POST,PUT,PATCH,DELETE）描述對資源進行什麼操作。符合這種設計風格的架構設計，我們就稱之為RESTful風格的架構。

為什麼要用RESTful？

首先要說明的一點就是，RESTful是一種設計風格，不是指導思想，也不是最佳實踐。只是有些情況下選用符合RESTful的架構確實更好一些。不吹不黑。

現在的網路時代，技術飛速發展。SOA啦，Web Service啦，微服務啦，各種概念各種思想層出不窮。客戶端也是瀏覽器，Android，iOS等都五花八門。

那麼在前後端分離的思想下，一般我們都是設計基於 HTTP API 的服務。這樣的好處是什麼呢？當然是一套API各種客戶端隨便用啦。

設計API的時候，我們一般有兩種方法：

一種是只要用 GET 請求和 POST 請求就足夠了，把操作放在URL上。

一種是RESTful的方式，URL只表示資源，用HTTP中不同的請求方法代表不同的操作。

假設有一類資源 ResourceXYZ ，對其有增刪查改的操作。如果只使用 GET POST 之類的設計方式，那麼很可能會設計以下的請求介面：

POST .../addResourceXYZ //新增資源
POST .../delResourceXYZ  //刪除資源
GET .../getResourceXYZ?resourceId=resourceId  //獲取指定ID的資源
POST .../updateResourceXYZ  //更新資源

如果按照 RESTful 的設計方式，很可能會設計以下的請求介面：

POST .../ResourceXYZs  //新增資源
DELETE .../ResourceXYZ/{resourceId}  //刪除資源
GET .../ResourceXYZ/{resourceId}  //獲取指定ID的資源
PUT .../ResourceXYZ/{resourceId}  //更新資源

那麼使用RESTful風格有什麼好處呢？

現在假設，客戶端要獲取該資源，其 ID 為 resourceId 。如果成功，那麼一切都好說。如果失敗， Restful 的處理方式是，通過 HTTP status 返回錯誤碼來表示原因，例如 404 表示該資源不存在。

那麼只用 GET POST 兩種方法的方式呢？響應請求

GET .../getResourceXYZ?resourceId=resourceId

的時候能不能也用 404 呢？

按照 404 的語義，響應 404 是不對的：因為客戶端請求的 URL 實際上是正確的，只是對應的參數沒有找到對應的結果。很多時候，就只能靠響應 200 然後返回空數據或者空對象來處理了。例如 Content-type 為 application/json 時，可以返回 {} 或者

{
    "error": "not found",
    "code": 404
}

這樣就會要求客戶端，必須處理 HTTP 回覆的具體內容，而不能只處理頭部。那麼客戶端要怎麼處理這個 json 呢？要先解析 json ，然後嘗試區分這是一個資源的內容，還是一個錯誤提示。

這樣前端的人就比較容易罵街了。

如何設計一個RESTful的架構呢？

我覺得這篇寫的很詳細很好了，這裡全文轉載阮一峰的RESTful API 設計指南。

以下為轉載開始：

一、協議

API與用戶的通信協議，總是使用HTTPs協議。

二、功能變數名稱

應該儘量將API部署在專用功能變數名稱之下。


https://api.example.com

如果確定API很簡單，不會有進一步擴展，可以考慮放在主功能變數名稱下。


https://example.org/api/

三、版本（Versioning）

應該將API的版本號放入URL。


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

另一種做法是，將版本號放在HTTP頭信息中，但不如放入URL方便和直觀。Github採用這種做法。

四、路徑（Endpoint）

路徑又稱"終點"（endpoint），表示API的具體網址。

在RESTful架構中，每個網址代表一種資源（resource），所以網址中不能有動詞，只能有名詞，而且所用的名詞往往與資料庫的表格名對應。一般來說，資料庫中的表都是同種記錄的"集合"（collection），所以API中的名詞也應該使用複數。

舉例來說，有一個API提供動物園（zoo）的信息，還包括各種動物和雇員的信息，則它的路徑應該設計成下麵這樣。

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

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

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

五、HTTP動詞

對於資源的具體操作類型，由HTTP動詞表示。

常用的HTTP動詞有下麵五個（括弧里是對應的SQL命令）。

GET（SELECT）：從伺服器取出資源（一項或多項）。

POST（CREATE）：在伺服器新建一個資源。

PUT（UPDATE）：在伺服器更新資源（客戶端提供改變後的完整資源）。

PATCH（UPDATE）：在伺服器更新資源（客戶端提供改變的屬性）。

DELETE（DELETE）：從伺服器刪除資源。

還有兩個不常用的HTTP動詞。

HEAD：獲取資源的元數據。

OPTIONS：獲取信息，關於資源的哪些屬性是客戶端可以改變的。

下麵是一些例子。

GET /zoos：列出所有動物園

POST /zoos：新建一個動物園

GET /zoos/ID：獲取某個指定動物園的信息

PUT /zoos/ID：更新某個指定動物園的信息（提供該動物園的全部信息）

PATCH /zoos/ID：更新某個指定動物園的信息（提供該動物園的部分信息）

DELETE /zoos/ID：刪除某個動物園

GET /zoos/ID/animals：列出某個指定動物園的所有動物

DELETE /zoos/ID/animals/ID：刪除某個指定動物園的指定動物

六、過濾信息（Filtering）

如果記錄數量很多，伺服器不可能都將它們返回給用戶。API應該提供參數，過濾返回結果。

下麵是一些常見的參數。

?limit=10：指定返回記錄的數量

?offset=10：指定返回記錄的開始位置。

?page=2&per_page=100：指定第幾頁，以及每頁的記錄數。

?sortby=name&order=asc：指定返回結果按照哪個屬性排序，以及排序順序。

?animal_type_id=1：指定篩選條件

參數的設計允許存在冗餘，即允許API路徑和URL參數偶爾有重覆。比如，GET /zoo/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的。

七、狀態碼（Status Codes）

伺服器向用戶返回的狀態碼和提示信息，常見的有以下一些（方括弧中是該狀態碼對應的HTTP動詞）。

200 OK - [GET]：伺服器成功返回用戶請求的數據，該操作是冪等的（Idempotent）。

201 CREATED - [POST/PUT/PATCH]：用戶新建或修改數據成功。

202 Accepted - [*]：表示一個請求已經進入後臺排隊（非同步任務）

204 NO CONTENT - [DELETE]：用戶刪除數據成功。

400 INVALID REQUEST - [POST/PUT/PATCH]：用戶發出的請求有錯誤，伺服器沒有進行新建或修改數據的操作，該操作是冪等的。

401 Unauthorized - [*]：表示用戶沒有許可權（令牌、用戶名、密碼錯誤）。

403 Forbidden - [*] 表示用戶得到授權（與401錯誤相對），但是訪問是被禁止的。

404 NOT FOUND - [*]：用戶發出的請求針對的是不存在的記錄，伺服器沒有進行操作，該操作是冪等的。

406 Not Acceptable - [GET]：用戶請求的格式不可得（比如用戶請求JSON格式，但是只有XML格式）。

410 Gone -[GET]：用戶請求的資源被永久刪除，且不會再得到的。

422 Unprocesable entity - [POST/PUT/PATCH] 當創建一個對象時，發生一個驗證錯誤。

500 INTERNAL SERVER ERROR - [*]：伺服器發生錯誤，用戶將無法判斷發出的請求是否成功。

狀態碼的完全列表參見這裡。

八、錯誤處理（Error handling）

如果狀態碼是4xx，就應該向用戶返回出錯信息。一般來說，返回的信息中將error作為鍵名，出錯信息作為鍵值即可。


{
    error: "Invalid API key"
}

九、返回結果

針對不同操作，伺服器向用戶返回的結果應該符合以下規範。

GET /collection：返回資源對象的列表（數組）

GET /collection/resource：返回單個資源對象

POST /collection：返回新生成的資源對象

PUT /collection/resource：返回完整的資源對象

PATCH /collection/resource：返回完整的資源對象

DELETE /collection/resource：返回一個空文檔

十、Hypermedia API

RESTful API最好做到Hypermedia，即返回結果中提供鏈接，連向其他API方法，使得用戶不查文檔，也知道下一步應該做什麼。

比如，當用戶向api.example.com的根目錄發出請求，會得到這樣一個文檔。


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

上面代碼表示，文檔中有一個link屬性，用戶讀取這個屬性就知道下一步該調用什麼API了。rel表示這個API與當前網址的關係（collection關係，並給出該collection的網址），href表示API的路徑，title表示API的標題，type表示返回類型。

Hypermedia API的設計被稱為HATEOAS。Github的API就是這種設計，訪問api.github.com會得到一個所有可用API的網址列表。


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

從上面可以看到，如果想獲取當前用戶的信息，應該去訪問api.github.com/user，然後就得到了下麵結果。


{
  "message": "Requires authentication",
  "documentation_url": "https://developer.github.com/v3"
}

上面代碼表示，伺服器給出了提示信息，以及文檔的網址。

十一、其他

（1）API的身份認證應該使用OAuth 2.0框架。

（2）伺服器返回的數據格式，應該儘量使用JSON，避免使用XML。

轉載結束。

支持RESTful的Java開發框架，有SpringMVC，Oracle的Jersey等。關於Jersey我還在學習，以後會寫專門的文章來總結。

參考文章：

知乎用戶覃超的回答：https://www.zhihu.com/question/28557115/answer/48094438

V2EX用戶noli的文章：https://www.v2ex.com/t/340607?p=2

阮一峰的博客：http://www.ruanyifeng.com/blog/2014/05/restful_api

RESTful三問