最流行的 RESTful API 要怎麼設計？

雲栖号資訊：【 點選檢視更多行業資訊

】

在這裡您可以找到不同行業的第一手的上雲資訊，還在等什麼，快來！

RESTful 是目前最流行的 API 設計規範，用于 Web 資料接口的設計。它的大原則容易把握，但是細節不容易做對。本文總結 RESTful 的設計細節，介紹如何設計出易于了解和使用的 API。

URL設計

動詞+賓語

RESTful的核心思想就是，用戶端發出的資料+操作指令都是“動詞+賓語”的結構，比如GET /articles這個指令，GET是動詞，/articles是賓語，動詞通常就有5種HTTP請求方法，對應CRUD操作，根據 HTTP 規範，動詞一律大寫。

# GET：讀取（Read）
# POST：建立（Create）
# PUT：更新（Update）
# PATCH：更新（Update），通常是部分更新# DELETE：删除（Delete）           

動詞的覆寫

有些用戶端隻能使用GET和POST這兩種方法。伺服器必須接受POST模拟其他三個方法（PUT、PATCH、DELETE）。這時，用戶端發出的 HTTP 請求，要加上X-HTTP-Method-Override屬性，告訴伺服器應該使用哪一個動詞，覆寫POST方法。

POST /api/Person/4 HTTP/1.1  X-HTTP-Method-Override: PUT           

上面代碼中，X-HTTP-Method-Override指定本次請求的方法是PUT，而不是POST。

賓語必須是名詞

賓語就是 API 的 URL，是 HTTP 動詞作用的對象。它應該是名詞，不能是動詞。比如，/articles這個 URL 就是正确的，而下面的 URL 不是名詞，是以都是錯誤的。

# /getAllCars# /createNewCar# /deleteAllRedCars           

複數 URL

既然 URL 是名詞，那麼應該使用複數，還是單數？這沒有統一的規定，但是常見的操作是讀取一個集合，比如GET /articles（讀取所有文章），這裡明顯應該是複數。

為了統一起見，建議都使用複數 URL，比如GET /articles/2要好于GET /article/2。

避免多級 URL

常見的情況是，資源需要多級分類，是以很容易寫出多級的 URL，比如擷取某個作者的某一類文章。

# GET /authors/12/categories/2           

這種 URL 不利于擴充，語義也不明确，往往要想一會，才能明白含義。

更好的做法是，除了第一級，其他級别都用查詢字元串表達。

# GET /authors/12?categories=2           

下面是另一個例子，查詢已釋出的文章。你可能會設計成下面的 URL。

# GET /articles/published           

查詢字元串的寫法明顯更好

# GET /articles?published=true           

狀态碼必須精确

用戶端的每一次請求，伺服器都必須給出回應。回應包括 HTTP 狀态碼和資料兩部分。

HTTP 狀态碼就是一個三位數，分成五個類别。

# 1xx：相關資訊# 2xx：操作成功# 3xx：重定向# 4xx：用戶端錯誤# 5xx：伺服器錯誤           

這五大類總共包含100多種狀态碼，覆寫了絕大部分可能遇到的情況。每一種狀态碼都有标準的（或者約定的）解釋，用戶端隻需檢視狀态碼，就可以判斷出發生了什麼情況，是以伺服器應該傳回盡可能精确的狀态碼。

API 不需要1xx狀态碼，下面介紹其他四類狀态碼的精确含義。

2XX狀态碼

200狀态碼表示操作成功，但是不同的方法可以傳回更精确的狀态碼。

# GET: 200 OK
# POST: 201 Created
# PUT: 200 OK
# PATCH: 200 OK
# DELETE: 204 No Content           

上面代碼中，POST傳回201狀态碼，表示生成了新的資源；DELETE傳回204狀态碼，表示資源已經不存在。

此外，202 Accepted狀态碼表示伺服器已經收到請求，但還未進行處理，會在未來再處理，通常用于異步操作。下面是一個例子。

HTTP/1.1 202 Accepted {"task": {"href": "/api/company/job-management/jobs/2130040","id": "2130040"}}           

3xx 狀态碼

API 用不到301狀态碼（永久重定向）和302狀态碼（暫時重定向，307也是這個含義），因為它們可以由應用級别傳回，浏覽器會直接跳轉，API 級别可以不考慮這兩種情況。

API 用到的3xx狀态碼，主要是303 See Other，表示參考另一個 URL。它與302和307的含義一樣，也是"暫時重定向"，差別在于302和307用于GET請求，而303用于POST、PUT和DELETE請求。

收到303以後，浏覽器不會自動跳轉，而會讓使用者自己決定下一步怎麼辦。下面是一個例子。

HTTP/1.1 303 See OtherLocation: /api/orders/12345           

4xx 狀态碼

4xx狀态碼表示用戶端錯誤，主要有下面幾種。

400 Bad Request：伺服器不了解用戶端的請求，未做任何處理。

401 Unauthorized：使用者未提供身份驗證憑據，或者沒有通過身份驗證。

403 Forbidden：使用者通過了身份驗證，但是不具有通路資源所需的權限。

404 Not Found：所請求的資源不存在，或不可用。

405 Method Not Allowed：使用者已經通過身份驗證，但是所用的 HTTP 方法不在他的權限之内。

410 Gone：所請求的資源已從這個位址轉移，不再可用。

415 Unsupported Media Type：用戶端要求的傳回格式不支援。比如，API 隻能傳回 JSON 格式，但是用戶端要求傳回 XML 格式。

422 Unprocessable Entity ：用戶端上傳的附件無法處理，導緻請求失敗。

429 Too Many Requests：用戶端的請求次數超過限額。

5xx 狀态碼

5xx狀态碼表示服務端錯誤。一般來說，API 不會向使用者透露伺服器的詳細資訊，是以隻要兩個狀态碼就夠了。

500 Internal Server Error：用戶端請求有效，伺服器處理時發生了意外。

503 Service Unavailable：伺服器無法處理請求，一般用于網站維護狀态。

不要傳回純本文

API 傳回的資料格式，不應該是純文字，而應該是一個 JSON 對象，因為這樣才能傳回标準的結構化資料。是以，伺服器回應的 HTTP 頭的Content-Type屬性要設為application/json。

用戶端請求時，也要明确告訴伺服器，可以接受 JSON 格式，即請求的 HTTP 頭的ACCEPT屬性也要設成application/json。下面是一個例子。

GET /orders/2 HTTP/1.1 Accept: application/json           

發生錯誤時，不要傳回 200 狀态碼

有一種不恰當的做法是，即使發生錯誤，也傳回200狀态碼，把錯誤資訊放在資料體裡面，就像下面這樣。

HTTP/1.1 200 OK Content-Type: application/json {"status": "failure","data": {"error": "Expected at least two items in list."}}           

上面代碼中，解析資料體以後，才能得知操作失敗。

這張做法實際上取消了狀态碼，這是完全不可取的。正确的做法是，狀态碼反映發生的錯誤，具體的錯誤資訊放在資料體裡面傳回。下面是一個例子。

HTTP/1.1 400 Bad RequestContent-Type: application/json{  "error": "Invalid payoad.",  "detail": {     "surname": "This field is required."  }}           

提供連結

API 的使用者未必知道，URL 是怎麼設計的。一個解決方法就是，在回應中，給出相關連結，便于下一步操作。這樣的話，使用者隻要記住一個 URL，就可以發現其他的 URL。這種方法叫做 HATEOAS。

舉例來說，GitHub 的 API 都在 api.github.com 這個域名。通路它，就可以得到其他 URL。

{  ...  "feeds_url": "https://api.github.com/feeds",  "followers_url": "https://api.github.com/user/followers",  "following_url": "https://api.github.com/user/following{/target}",  "gists_url": "https://api.github.com/gists{/gist_id}",  "hub_url": "https://api.github.com/hub",  ...}           

上面的回應中，挑一個 URL 通路，又可以得到别的 URL。對于使用者來說，不需要記住 URL 設計，隻要從 api.github.com 一步步查找就可以了。

HATEOAS 的格式沒有統一規定，上面例子中，GitHub 将它們與其他屬性放在一起。更好的做法應該是，将相關連結與其他屬性分開。

HTTP/1.1 200 OK Content-Type: application/json{"status": "In progress","links": {[{ "rel":"cancel", "method": "delete", "href":"/api/status/12345" } ,{ "rel":"edit", "method": "put", "href":"/api/status/12345" }]}}           

【雲栖号線上課堂】每天都有産品技術專家分享！

課程位址：

https://yqh.aliyun.com/zhibo

立即加入社群，與專家面對面，及時了解課程最新動态！

【雲栖号線上課堂 社群】

https://c.tb.cn/F3.Z8gvnK

原文釋出時間：2020-06-16

本文作者：阮一峰

本文來自：“

網際網路架構師 微信公衆号

”，了解相關資訊可以關注“

網際網路架構師

”