1.概述

1.詞意

REST，即Representational State Transfer的縮寫，翻譯是"表現層狀態轉化"。

如果一個架構符合REST原則，就稱它為RESTful架構。

Representational（具像的? 指的資源） State（狀態） Transfer（傳輸）

2.資源

所謂"資源"，就是網絡上的一個實體，或者說是網絡上的一個具體信息。它可以是一段文本、一張圖片、一首歌曲、一種服務，總之就是一個具體的實在。

你可以用一個URI（統一資源定位符）指向它，每種資源對應一個特定的URI。要獲取這個資源，訪問它的URI就可以，因此URI就成了每一個資源的地址或獨一無二的識別符。

所謂"上網"，就是與互聯網上一系列的"資源"互動，調用它的URI。

3.Representation

表現層："資源"是一種信息實體，它可以有多種外在表現形式。我們把"資源"具體呈現出來的形式，叫做它的"表現層"（Representation）

表現層例子：文本可以用txt格式表現，也可以用HTML格式、XML格式、JSON格式表現，甚至可以采用二進制格式；圖片可以用JPG格式表現，也可以用PNG格式表現；則以上的txt html xml等格式都是表現層。

URI只代表資源的實體，不代表它的形式。嚴格地說，有些網址最后的".html"后綴名是不必要的，因為這個后綴名表示格式，屬于"表現層"范疇，而URI應該只代表"資源"的位置。

它的具體表現形式，應該在HTTP請求的頭信息中用Accept和Content-Type字段指定，這兩個字段才是對"表現層"的描述。

4.State Transfer

訪問一個網站，就代表了客戶端和服務器的一個互動過程。在這個過程中，勢必涉及到數據和狀態的變化。

互聯網通信協議HTTP協議，是一個無狀態協議。這意味著，所有的狀態都保存在服務器端。因此，如果客戶端想要操作服務器，必須通過某種手段，讓服務器端發生"狀態轉化"（State Transfer）。而這種轉化是建立在表現層(服務器的資源)之上的，所以就是"表現層狀態轉化"。

客戶端用到的手段，只能是HTTP協議。具體來說，就是HTTP協議里面，四個表示操作方式的動詞：GET、POST、PUT、DELETE。它們分別對應四種基本操作：

GET用來獲取資源，

POST用來新建資源（也可以用于更新資源），

PUT用來更新資源，

DELETE用來刪除資源。

5.綜述

綜合上面的解釋，我們總結一下什么是RESTful架構：

（1）每一個URI代表一種資源；（一個url對應一個服務器資源）

（2）客戶端和服務器之間，傳遞這種資源的某種表現層；（變化在客戶端與服務端發生）

（3）客戶端通過四個HTTP動詞，對服務器端資源進行操作，實現"表現層狀態轉化"。（服務器資源的轉化依靠http動詞）

2.使用

1.域名

應該盡量將API部署在專用域名之下。

https://api.example.com

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

https://example.org/api/

2.版本

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

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

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

3.路徑

在RESTful架構中，每個網址代表一種資源（resource），所以網址中不能有動詞，只能有名詞，而且所用的名詞往往與數據庫的表格名對應。

一般來說，數據庫中的表都是同種記錄的"集合"（collection），所以API中的名詞也應該使用復數。

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

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

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

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

4.動詞

動詞： GET（SELECT）：從服務器取出資源（一項或多項）。 POST（CREATE）：在服務器新建一個資源。 PUT（UPDATE）：在服務器更新資源（客戶端提供改變后的完整資源）。 PATCH（UPDATE）：在服務器更新資源（客戶端提供改變的屬性）。 DELETE（DELETE）：從服務器刪除資源。 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：刪除某個指定動物園的指定動物

5.Filtering

?limit=10：指定返回記錄的數量 ?offset=10：指定返回記錄的開始位置。 ?page=2&per_page=100：指定第幾頁，以及每頁的記錄數。 ?sortby=name&order=asc：指定返回結果按照哪個屬性排序，以及排序順序。 ?animal_type_id=1：指定篩選條件

6.Status Codes

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 - [*]：服務器發生錯誤，用戶將無法判斷發出的請求是否成功。

7.error

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

{error: "Invalid API key" }

8.返回結果

GET /collection：返回資源對象的列表（數組） GET /collection/resource：返回單個資源對象 POST /collection：返回新生成的資源對象 PUT /collection/resource：返回完整的資源對象 PATCH /collection/resource：返回完整的資源對象 DELETE /collection/resource：返回一個空文檔

9.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" }

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

10.區別

傳統的對于資源的操作定義在方法內部

restful是對于資源的操作定義在http方法里面? 不用再代碼里面注明? 在路由里面注明

?

?

?

總結

以上是生活随笔為你收集整理的Go的RESTful的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。