簡介
REST（英文：Representational State Transfer，簡稱REST）描述了一個架構樣式的網絡系統，比如 web 應用程序。它首次出現在 2000 年 Roy Fielding 的博士論文中，他是 HTTP 規范的主要編寫者之一。在目前主流的三種Web服務交互方案中，REST相比於SOAP（Simple Object Access protocol，簡單對象訪問協議）以及XML-RPC更加簡單明了，無論是對URL的處理還是對Payload的編碼，REST都傾向於用更加簡單輕量的方法設計和實現。值得注意的是REST並沒有一個明確的標准，而更像是一種設計的風格。
定義：簡單來說REST是一種系統架構設計風格（而非標准），一種分布式系統的應用層解決方案。
目的：Client和Server端進一步解耦。
一、協議
API與用戶的通信協議，總是使用HTTPs協議。
二、域名
1.應該盡量將API部署在專用域名之下,(這中情況會存在跨域問題)
https://api.example.com
2.如果確定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應該提供參數，過濾返回結果。
下面是一些常見的參數。
-
https://api.example.com/v1/zoos?limit=10：指定返回記錄的數量
-
https://api.example.com/v1/zoos?offset=10：指定返回記錄的開始位置
-
https://api.example.com/v1/zoos?page=2&per_page=100：指定第幾頁，以及每頁的記錄數
-
https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回結果按照哪個屬性排序，以及排序順序
-
https://api.example.com/v1/zoos?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。