RestFul API 是每個程式設計師都應該了解並掌握的基本知識，我們在開發過程中設計API的時候也應該至少要滿足RestFul API的最基本的要求（比如接口中儘量使用名詞，使用POST 請求創建資源，DELETE請求刪除資源等等，示例：GET /notes/id：獲取某個指定id的筆記的信息）。最近學習過程中接觸到這些東西，自己沒有時間總結，所以分享一些不錯的文章給大家。
相關閱讀：
•http://www.ruanyifeng.com/blog/2014/05/restful_api.html（阮一峰，這篇文章大部分內容來源）•https://www.baeldung.com/spring-hateoas-tutorial(RestFul API Tutorial)•https://aisensiy.github.io/2017/06/04/spring-boot-and-hateoas/(Spring中使用HATEOAS)•https://spring.io/guides/tutorials/bookmarks/ (Building REST services with Spring)•https://www.baeldung.com/spring-hateoas-tutorial(https://www.baeldung.com/spring-hateoas-tutorial)
備註：HATEOAS這個大家可能之前並沒有怎麼接觸過，我看了很多項目的源碼也並沒有滿足HATEOAS設計的要求，實際上RestFul API 最好滿足HATEOAS設計，也就是在返回結果中提供連結，連向其他API方法，使得用戶不查文檔，也知道下一步應該做什麼。一、重要概念：REST,即Representational State Transfer的縮寫，翻譯過來就是"表現層狀態轉化"。
Resource（資源） ：對象的單個實例。例如，一隻動物。它可以是一段文本、一張圖片、一首歌曲、一種服務，總之就是一個具體的實在。你可以用一個URI（統一資源定位符）指向它，每種資源對應一個特定的URI。要獲取這個資源，訪問它的URI就可以，因此URI就成了每一個資源的地址或獨一無二的識別符。
集合：對象的集合。例如，動物。
第三方：使用我們接口的開發者
表現層（Representation）："資源"是一種信息實體，它可以有多種外在表現形式。我們把"資源"具體呈現出來的形式，叫做它的"表現層"（Representation）。
狀態轉化（State Transfer） 訪問一個網站，就代表了客戶端和伺服器的一個互動過程。在這個過程中，勢必涉及到數據和狀態的變化。網際網路通信協議HTTP協議，是一個無狀態協議。這意味著，所有的狀態都保存在伺服器端。因此，如果客戶端想要操作伺服器，必須通過某種手段，讓伺服器端發生"狀態轉化"（State Transfer）。而這種轉化是建立在表現層之上的，所以就是"表現層狀態轉化"。
綜合上面的解釋，我們總結一下什麼是RESTful架構：
（1）每一個URI代表一種資源；
（2）客戶端和伺服器之間，傳遞這種資源的某種表現層；
（3）客戶端通過HTTP動詞(GET,POST等等)，對伺服器端資源進行操作，實現"表現層狀態轉化"。
二、REST接口規範1、動作GET （SELECT）：從伺服器檢索特定資源，或資源列表。
POST （CREATE）：在伺服器上創建一個新的資源。
PUT （UPDATE）：更新伺服器上的資源（客戶端提供更新後的整個資源）。
PATCH （UPDATE）：更新伺服器上的資源（客戶端提供更改的屬性，可以看做作是部分更新）。
DELETE （DELETE）：從伺服器刪除資源。
2、路徑（接口命名）路徑又稱"終點"（endpoint），表示API的具體網址。
在RESTful架構中，每個網址代表一種資源（resource），所以網址中不能有動詞，只能有名詞，而且所用的名詞往往與資料庫的表格名對應。一般來說，資料庫中的表都是同種記錄的"集合"（collection），所以API中的名詞也應該使用複數。
舉例來說，有一個API提供動物園（zoo）的信息，還包括各種動物和僱員的信息，則它的路徑應該設計成下面這樣。
接口儘量使用名詞，禁止使用動詞，下面是一些例子。
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：刪除某個指定動物園的指定動物複製代碼
反例：
/getAllCars
/createNewCar
/deleteAllRedCars複製代碼
再比如，某個URI是/posts/show/1，其中show是動詞，這個URI就設計錯了，正確的寫法應該是/posts/1，然後用GET方法表示show。
如果某些動作是HTTP動詞表示不了的，你就應該把動作做成一種資源。比如網上匯款，從帳戶1向帳戶2匯款500元，錯誤的URI是：
POST /accounts/1/transfer/500/to/2
正確的寫法是把動詞transfer改成名詞transaction，資源不能是動詞，但是可以是一種服務：
POST /transaction HTTP/1.1
Host: 127.0.0.1
from=1&to=2&amount=500.00
理清資源的層次結構，比如業務針對的範圍是學校，那麼學校會是一級資源(/school)，老師(/school/teachers)，學生(/school/students)就是二級資源。
3、版本（Versioning）應該將API的版本號放入URL。如：
https://api.example.com/v1/複製代碼
另一種做法是，將版本號放在HTTP頭信息中，但不如放入URL方便和直觀。Github採用這種做法。
4、過濾信息（Filtering）如果記錄數量很多，伺服器不可能都將它們返回給用戶。API應該提供參數，過濾返回結果。下面是一些常見的參數。
?limit=10：指定返回記錄的數量
?offset=10：指定返回記錄的開始位置。
?page_number=2&page_size=100：指定第幾頁，以及每頁的記錄數。
?sortby=name&order=asc：指定返回結果按照哪個屬性排序，以及排序順序。
?animal_type_id=1：指定篩選條件
參數的設計允許存在冗餘，即允許API路徑和URL參數偶爾有重複。比如，
GET /zoo/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的。複製代碼
狀態碼範圍
1xx 信息，請求收到，繼續處理。範圍保留用於底層HTTP的東西，你很可能永遠也用不到。
2xx 成功，行為被成功地接受、理解和採納
3xx 重定向，為了完成請求，必須進一步執行的動作
4xx 客戶端錯誤，請求包含語法錯誤或者請求無法實現。範圍保留用於響應客戶端做出的錯誤，例如。他們提供不良數據或要求不存在的東西。這些請求應該是冪等的，而不是更改伺服器的狀態。
5xx 範圍的狀態碼是保留給伺服器端錯誤用的。這些錯誤常常是從底層的函數拋出來的，甚至
開發人員也通常沒法處理，發送這類狀態碼的目的以確保客戶端獲得某種響應。
當收到5xx響應時，客戶端不可能知道伺服器的狀態，所以這類狀態碼是要儘可能的避免。複製代碼
伺服器向用戶返回的狀態碼和提示信息，常見的有以下一些（方括號中是該狀態碼對應的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 - [*]：伺服器發生錯誤，用戶將無法判斷發出的請求是否成功。
502 網關錯誤
503 Service Unavailable
504 網關超時
上面是RESTful 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。
在Spring 中有一個叫做HATEOAS的API 庫，通過它我們可以更輕鬆的創建除符合 HATEOAS 設計的API。
推薦閱讀
乾貨收藏 | Java程式設計師必備的一些流程圖
一個不錯的技術面試官是怎麼樣的？
很重要！但是大部分Java程式設計師都會忽略的幾個問題（1）。
Arrays.asList()使用指南
Github 6月最熱門Java項目指南
【面試】如果把線程當作一個人來對待，所有問題都瞬間明白了
如何超過大多數人
MySQL知識點總結[修訂版]
十分鐘搞懂Java效率工具Lombok使用與原理
看完這篇文章，別說自己不會用Lambda表達式了！
Github上有哪些Java面試/學習相關的倉庫推薦?
一些有助於你拿Offer的文章
15個經典的Spring面試常見問題
面試官:「談談Spring中都用到了那些設計模式?」。
盤點阿里巴巴 15 款開發者工具