https://www.cnblogs.com/softidea/p/10158703.html
https://sscms.com/docs/v6/api/guide
用一句話來概括RESTful API(具有REST風格的API):
用URL定位資源，
用HTTP動詞（GET,HEAD,POST,PUT,PATCH,DELETE）描述操作，用響應狀態(tài)碼表示操作結(jié)果。
| HTTP動詞 | 說明 | |
|---|---|---|
| GET | 安全、冪等； | 用于獲取資源；getUserById getUserList
|
| HEAD | 安全、冪等； | 與get方法類似，但不返回message body內(nèi)容，僅僅是獲得獲取資源的部分信息（content-type、content-length）restful框架中較少使用 |
| POST | 非安全、非冪等； | 用于創(chuàng)建子資源addUser addUserList
|
| PUT | 非安全、冪等； | 用于創(chuàng)建、更新資源；(客戶端改變后的完整資源) updateUser
|
| DELETE | 非安全、冪等； | 刪除資源；delUser
|
| OPTIONS | 安全、冪等； | 用于url驗證，驗證接口服務是否正常； |
| TRACE | 安全、冪等； | “回顯服務器收到的請求，這樣客戶端可以看到（如果有）哪一些改變或者添加已經(jīng)被中間服務器實現(xiàn)?！眗estful框架中較少使用 |
| PATCH | 非安全、冪等； | 用于創(chuàng)建、更新資源，于PUT類似，區(qū)別在于PATCH代表部分更新；updateUserList
|
GET（SELECT）：從服務器獲取資源（一個資源或資源集合）。
POST（CREATE）：在服務器新建一個資源（也可以用于更新資源）。
PUT（UPDATE）：在服務器更新資源（客戶端提供改變后的完整資源）。
PATCH（UPDATE）：在服務器更新資源（客戶端提供改變的部分）。
DELETE（DELETE）：從服務器刪除資源。
HEAD：獲取資源的元數(shù)據(jù)。
OPTIONS：獲取信息，關于資源的哪些屬性是客戶端可以改變的。
GET、HEAD、PUT、DELETE方法是冪等方法(對于同一個內(nèi)容的請求，發(fā)出n次的效果與發(fā)出1次的效果相同)。
GET、HEAD方法是安全方法(不會造成服務器上資源的改變)。
PATCH不一定是冪等的。PATCH的實現(xiàn)方式有可能是"提供一個用來替換的數(shù)據(jù)"，也有可能是"提供一個更新數(shù)據(jù)的方法"(比如data++)。如果是后者，那么PATCH不是冪等的。
URI
可以用一個URI（統(tǒng)一資源定位符）指向資源，即每個URI都對應一個特定的資源。要獲取這個資源，訪問它的URI就可以，因此URI就成了每一個資源的地址或識別符。
一般的，每個資源至少有一個URI與之對應，最典型的URI即URL。
RESTful API 設計指南
作者： 阮一峰
網(wǎng)絡應用程序，分為前端和后端兩個部分。當前的發(fā)展趨勢，就是前端設備層出不窮（手機、平板、桌面電腦、其他專用設備......）。
因此，必須有一種統(tǒng)一的機制，方便不同的前端設備與后端進行通信。這導致API構(gòu)架的流行，甚至出現(xiàn)"API First"的設計思想。RESTful API是目前比較成熟的一套互聯(lián)網(wǎng)應用程序的API設計理論。我以前寫過一篇《理解RESTful架構(gòu)》，探討如何理解這個概念。
今天，我將介紹RESTful API的設計細節(jié)，探討如何設計一套合理、好用的API。我的主要參考了兩篇文章（1，2）。
一、協(xié)議
API與用戶的通信協(xié)議，總是使用HTTPs協(xié)議。
二、域名
應該盡量將API部署在專用域名之下。
https://api.example.com
如果確定API很簡單，不會有進一步擴展，可以考慮放在主域名下。
https://example.org/api/
三、版本（Versioning）
應該將API的版本號放入URL。
https://api.example.com/v1/
另一種做法是，將版本號放在HTTP頭信息中，但不如放入URL方便和直觀。Github采用這種做法。
四、路徑（Endpoint）
路徑又稱"終點"（endpoint），表示API的具體網(wǎng)址。
在RESTful架構(gòu)中，每個網(wǎng)址代表一種資源（resource），所以網(wǎng)址中不能有動詞，只能有名詞，而且所用的名詞往往與數(shù)據(jù)庫的表格名對應。一般來說，數(shù)據(jù)庫中的表都是同種記錄的"集合"（collection），所以API中的名詞也應該使用復數(shù)。
舉例來說，有一個API提供動物園（zoo）的信息，還包括各種動物和雇員的信息，則它的路徑應該設計成下面這樣。
五、HTTP動詞
對于資源的具體操作類型，由HTTP動詞表示。
常用的HTTP動詞有下面五個（括號里是對應的SQL命令）。
- GET（SELECT）：從服務器取出資源（一項或多項）。
- POST（CREATE）：在服務器新建一個資源。
- PUT（UPDATE）：在服務器更新資源（客戶端提供改變后的完整資源）。
- PATCH（UPDATE）：在服務器更新資源（客戶端提供改變的屬性）。
- DELETE（DELETE）：從服務器刪除資源。
還有兩個不常用的HTTP動詞。
- HEAD：獲取資源的元數(shù)據(jù)。
- 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）
如果記錄數(shù)量很多，服務器不可能都將它們返回給用戶。API應該提供參數(shù)，過濾返回結(jié)果。
下面是一些常見的參數(shù)。
- ?limit=10：指定返回記錄的數(shù)量
- ?offset=10：指定返回記錄的開始位置。
- ?page=2&per_page=100：指定第幾頁，以及每頁的記錄數(shù)。
- ?sortby=name&order=asc：指定返回結(jié)果按照哪個屬性排序，以及排序順序。
- ?animal_type_id=1：指定篩選條件
參數(shù)的設計允許存在冗余，即允許API路徑和URL參數(shù)偶爾有重復。比如，GET /zoo/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的。
七、狀態(tài)碼（Status Codes）
服務器向用戶返回的狀態(tài)碼和提示信息，常見的有以下一些（方括號中是該狀態(tài)碼對應的HTTP動詞）。
- 200 OK - [GET]：服務器成功返回用戶請求的數(shù)據(jù)，該操作是冪等的（Idempotent）。
- 201 CREATED - [POST/PUT/PATCH]：用戶新建或修改數(shù)據(jù)成功。
- 202 Accepted - [*]：表示一個請求已經(jīng)進入后臺排隊（異步任務）
- 204 NO CONTENT - [DELETE]：用戶刪除數(shù)據(jù)成功。
- 400 INVALID REQUEST - [POST/PUT/PATCH]：用戶發(fā)出的請求有錯誤，服務器沒有進行新建或修改數(shù)據(jù)的操作，該操作是冪等的。
- 401 Unauthorized - [*]：表示用戶沒有權(quán)限（令牌、用戶名、密碼錯誤）。
- 403 Forbidden - [*] 表示用戶得到授權(quán)（與401錯誤相對），但是訪問是被禁止的。
- 404 NOT FOUND - [*]：用戶發(fā)出的請求針對的是不存在的記錄，服務器沒有進行操作，該操作是冪等的。
- 406 Not Acceptable - [GET]：用戶請求的格式不可得（比如用戶請求JSON格式，但是只有XML格式）。
- 410 Gone -[GET]：用戶請求的資源被永久刪除，且不會再得到的。
- 422 Unprocesable entity - [POST/PUT/PATCH] 當創(chuàng)建一個對象時，發(fā)生一個驗證錯誤。
- 500 INTERNAL SERVER ERROR - [*]：服務器發(fā)生錯誤，用戶將無法判斷發(fā)出的請求是否成功。
狀態(tài)碼的完全列表參見這里。
八、錯誤處理（Error handling）
如果狀態(tài)碼是4xx，就應該向用戶返回出錯信息。一般來說，返回的信息中將error作為鍵名，出錯信息作為鍵值即可。
{ error: "Invalid API key" }
九、返回結(jié)果
針對不同操作，服務器向用戶返回的結(jié)果應該符合以下規(guī)范。
- GET /collection：返回資源對象的列表（數(shù)組）
- GET /collection/resource：返回單個資源對象
- POST /collection：返回新生成的資源對象
- PUT /collection/resource：返回完整的資源對象
- PATCH /collection/resource：返回完整的資源對象
- DELETE /collection/resource：返回一個空文檔
十、Hypermedia API
RESTful API最好做到Hypermedia，即返回結(jié)果中提供鏈接，連向其他API方法，使得用戶不查文檔，也知道下一步應該做什么。
比如，當用戶向api.example.com的根目錄發(fā)出請求，會得到這樣一個文檔。
{"link": { "rel": "collection https://www.example.com/zoos", "href": "https://api.example.com/zoos", "title": "List of zoos", "type": "application/vnd.yourformat+json" }}
上面代碼表示，文檔中有一個link屬性，用戶讀取這個屬性就知道下一步該調(diào)用什么API了。rel表示這個API與當前網(wǎng)址的關系（collection關系，并給出該collection的網(wǎng)址），href表示API的路徑，title表示API的標題，type表示返回類型。
Hypermedia API的設計被稱為HATEOAS。Github的API就是這種設計，訪問api.github.com會得到一個所有可用API的網(wǎng)址列表。
{ "current_user_url": "https://api.github.com/user", "authorizations_url": "https://api.github.com/authorizations", // ... }
從上面可以看到，如果想獲取當前用戶的信息，應該去訪問api.github.com/user，然后就得到了下面結(jié)果。
{ "message": "Requires authentication", "documentation_url": "https://developer.github.com/v3" }
上面代碼表示，服務器給出了提示信息，以及文檔的網(wǎng)址。
十一、其他
（1）API的身份認證應該使用OAuth 2.0框架。
（2）服務器返回的數(shù)據(jù)格式，應該盡量使用JSON，避免使用XML。
