避免自己寫的 Url 被diss！建議看看這篇RestFul API簡明教程！

作者：JavaGuide 2020-03-25 11:04:18

RestFul API 是每個程序員都應該了解并掌握的基本知識，我們在開發過程中設計 API 的時候也應該至少要滿足 RestFul API 的最基本的要求(比如接口中盡量使用名詞，使用 POST 請求創建資源，DELETE 請求刪除資源等等，示例：GET /notes/id：獲取某個指定 id 的筆記的信息)。

如果你看 RestFul API 相關的文章的話一般都比較晦澀難懂，包括我下面的文章也會提到一些概念性的東西。但是，實際上我們平時開發用到的 RestFul API 的知識非常簡單也很容易概括!舉個例子,如果我給你下面兩個 url 你是不是立馬能知道它們是干什么的!這就是 RestFul API 的強大之處!

RestFul API 可以你看到 url + http method 就知道這個 url 是干什么的，讓你看到了 http 狀態碼(status code)就知道請求結果如何。

GET    /classs：列出所有班級 
POST   /classs：新建一個班級

下面的內容只是介紹了我覺得關于 RestFul API 比較重要的一些東西，歡迎補充。

一、重要概念

REST,即 REpresentational State Transfer 的縮寫。這個詞組的翻譯過來就是"表現層狀態轉化"。這樣理解起來甚是晦澀，實際上 REST 的全稱是 Resource Representational State Transfe ，直白地翻譯過來就是 “資源”在網絡傳輸中以某種“表現形式”進行“狀態轉移” 。如果還是不能繼續理解，請繼續往下看，相信下面的講解一定能讓你理解到底啥是 REST 。

我們分別對上面涉及到的概念進行解讀，以便加深理解，不過實際上你不需要搞懂下面這些概念，也能看懂我下一部分要介紹到的內容。不過，為了更好地能跟別人扯扯 “RestFul API”我建議你還是要好好理解一下!

資源(Resource) ：我們可以把真實的對象數據稱為資源。一個資源既可以是一個集合，也可以是單個個體。比如我們的班級 classs 是代表一個集合形式的資源，而特定的 class 代表單個個體資源。每一種資源都有特定的 URI(統一資源定位符)與之對應，如果我們需要獲取這個資源，訪問這個 URI 就可以了，比如獲取特定的班級：/class/12。另外，資源也可以包含子資源，比如 /classs/classId/teachers：列出某個指定班級的所有老師的信息
表現形式(Representational)："資源"是一種信息實體，它可以有多種外在表現形式。我們把"資源"具體呈現出來的形式比如 json，xml，image,txt 等等叫做它的"表現層/表現形式"。
狀態轉移(State Transfer) ：大家第一眼看到這個詞語一定會很懵逼?內心 BB：這尼瑪是啥啊?大白話來說 REST 中的狀態轉移更多地描述的服務器端資源的狀態，比如你通過增刪改查(通過 HTTP 動詞實現)引起資源狀態的改變。ps:互聯網通信協議 HTTP 協議，是一個無狀態協議，所有的資源狀態都保存在服務器端。

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

每一個 URI 代表一種資源;
客戶端和服務器之間，傳遞這種資源的某種表現形式比如 json，xml，image,txt 等等;
客戶端通過特定的 HTTP 動詞，對服務器端資源進行操作，實現"表現層狀態轉化"。

二、REST 接口規范

1、動作

GET ：請求從服務器獲取特定資源。舉個例子：GET /classs(獲取所有班級)
POST ：在服務器上創建一個新的資源。舉個例子：POST /classs(創建班級)
PUT ：更新服務器上的資源(客戶端提供更新后的整個資源)。舉個例子：PUT /classs/12(更新編號為 12 的班級)
DELETE ：從服務器刪除特定的資源。舉個例子：DELETE /classs/12(刪除編號為 12 的班級)
PATCH ：更新服務器上的資源(客戶端提供更改的屬性，可以看做作是部分更新)，使用的比較少，這里就不舉例子了。

2、路徑(接口命名)

路徑又稱"終點"(endpoint)，表示 API 的具體網址。實際開發中常見的規范如下：

網址中不能有動詞，只能有名詞，API 中的名詞也應該使用復數。因為 REST 中的資源往往和數據庫中的表對應，而數據庫中的表都是同種記錄的"集合"(collection)。如果 API 調用并不涉及資源(如計算，翻譯等操作)的話，可以用動詞。比如：GET /calculate?param1=11¶m2=33
不用大寫字母，建議不用中杠 - 不用下杠 _ 比如邀請碼寫成 invitation-code而不是invitation_code

Talk is cheap!來舉個實際的例子來說明一下吧!現在有這樣一個 API 提供班級(class)的信息，還包括班級中的學生和教師的信息，則它的路徑應該設計成下面這樣。

接口盡量使用名詞，禁止使用動詞。下面是一些例子：

GET    /classs：列出所有班級 
POST   /classs：新建一個班級 
GET    /classs/classId：獲取某個指定班級的信息 
PUT    /classs/classId：更新某個指定班級的信息（一般傾向整體更新） 
PATCH  /classs/classId：更新某個指定班級的信息（一般傾向部分更新） 
DELETE /classs/classId：刪除某個班級 
GET    /classs/classId/teachers：列出某個指定班級的所有老師的信息 
GET    /classs/classId/students：列出某個指定班級的所有學生的信息 
DELETE classs/classId/teachers/ID：刪除某個指定班級下的指定的老師的信息

反例：

/getAllclasss 
/createNewclass 
/deleteAllActiveclasss

理清資源的層次結構，比如業務針對的范圍是學校，那么學校會是一級資源:/schools，老師: /schools/teachers，學生: /schools/students 就是二級資源。

3、過濾信息(Filtering)

如果我們在查詢的時候需要添加特定條件的話，建議使用 url 參數的形式。比如我們要查詢 state 狀態為 active 并且 name 為 guidegege 的班級：

GET    /classs?state=active&name=guidegege

比如我們要實現分頁查詢：

GET    /classs?page=1&size=10 //指定第1頁，每頁10個數據

4、狀態碼(Status Codes)

三、HATEOAS

RestFul 的極致是 hateoas ，但是這個基本不會在實際項目中用到。

上面是 RESTful API 最基本的東西，也是我們平時開發過程中最容易實踐到的。實際上，RESTful API 最好做到 Hypermedia，即返回結果中提供鏈接，連向其他 API 方法，使得用戶不查文檔，也知道下一步應該做什么。

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

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

上面代碼表示，文檔中有一個 link 屬性，用戶讀取這個屬性就知道下一步該調用什么 API 了。rel 表示這個 API 與當前網址的關系(collection 關系，并給出該 collection 的網址)，href 表示 API 的路徑，title 表示 API 的標題，type 表示返回類型 Hypermedia API 的設計被稱為HATEOAS。

在 Spring 中有一個叫做 HATEOAS 的 API 庫，通過它我們可以更輕松的創建除符合 HATEOAS 設計的 API。

責任編輯：武曉燕來源： Guide哥