restful 介面設計規範
restful 介面設計規範
1. 域名
應該儘量將API部署在專用域名之下。
https://api.example.com
如果確定API很簡單,不會有進一步擴充套件,可以考慮放在主域名下。
https://www.example.org/api/
2. 版本(Versioning)
應該將API的版本號放入URL。
http://www.example.com/app/1.0/foo
http://www.example.com/app/1.1/foo
http://www.example.com/app/2.0/foo
另一種做法是,將版本號放在HTTP頭資訊中,但不如放入URL方便和直觀。Github就採用了這種做法。
因為不同的版本,可以理解成同一種資源的不同表現形式,所以應該採用同一個URL。版本號可以在HTTP請求頭資訊的Accept欄位中進行區分(參見Versioning REST Services):
Accept: vnd.example-com.foo+json; version=1.0
Accept: vnd.example-com.foo+json; version=1.1
Accept: vnd.example-com.foo+json; version=2.0
3. 路徑(Endpoint)
路徑又稱"終點"(endpoint),表示API的具體網址,每個網址代表一種資源(resource)
(1) 資源作為網址,只能有名詞,不能有動詞,而且所用的名詞往往與資料庫的表名對應。
舉例來說,以下是不好的例子:
/getProducts
/listOrders
/retreiveClientByOrder?orderId=1
對於一個簡潔結構,你應該始終用名詞。 此外,利用的HTTP方法可以分離網址中的資源名稱的操作。
GET /products :將返回所有產品清單
POST /products :將產品新建到集合
GET /products/4 :將獲取產品 4
PATCH(或)PUT /products/4 :將更新產品 4
(2) API中的名詞應該使用複數。無論子資源或者所有資源。
舉例來說,獲取產品的API可以這樣定義
獲取單個產品:http://127.0.0.1:8080/AppName/rest/products/1
獲取所有產品: http://127.0.0.1:8080/AppName/rest/products
3. HTTP動詞
對於資源的具體操作型別,由HTTP動詞表示。
常用的HTTP動詞有下面四個(括號裡是對應的SQL命令)。
- GET(SELECT):從伺服器取出資源(一項或多項)。
- POST(CREATE):在伺服器新建一個資源。
- PUT(UPDATE):在伺服器更新資源(客戶端提供改變後的完整資源)。
- DELETE(DELETE):從伺服器刪除資源。
CURD Create、Update、Read、Delete 增刪查改,這四個資料庫的常用操作
還有三個不常用的HTTP動詞。
- PATCH(UPDATE):在伺服器更新(更新)資源(客戶端提供改變的屬性)。
- 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:刪除某個指定動物園的指定動物
4. 過濾資訊(Filtering)
如果記錄數量很多,伺服器不可能都將它們返回給使用者。API應該提供引數,過濾返回結果。
下面是一些常見的引數。query_string 查詢字串,位址列後面問號後面的資料,格式: name=xx&sss=xxx
完整的URL地址格式:
協議://域名(IP):埠號/路徑?查詢字串#錨點
?limit=10:指定返回記錄的數量
?offset=10:指定返回記錄的開始位置。
?page=2&per_page=100:指定第幾頁,以及每頁的記錄數。
?sortby=name&order=asc:指定返回結果按照哪個屬性排序,以及排序順序。
?animal_type_id=1:指定篩選條件
引數的設計允許存在冗餘,即允許API路徑和URL引數偶爾有重複。比如,GET /zoos/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的。
6. 狀態碼(Status Codes)
1xx 表示當前本次請求還是持續,沒結束
2xx 表示當前本次請求成功
3xx 表示當前本次請求成功,但是伺服器進行代理操作/重定向
4xx 表示當前本次請求失敗,主要是客戶端發生了錯誤
5xx 表示當前本次請求失敗,主要是伺服器發生了錯誤
伺服器向用戶返回的狀態碼和提示資訊,常見的有以下一些(方括號中是該狀態碼對應的HTTP動詞)。
- 200 OK - [GET]:伺服器成功返回使用者請求的資料
- 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 - [*]:伺服器發生錯誤,使用者將無法判斷髮出的請求是否成功。
- 507 資料儲存出錯,往往資料庫操作錯誤出錯,伺服器就返回這個
7. 錯誤處理(Error handling)
如果狀態碼是4xx,伺服器就應該向使用者返回出錯資訊。一般來說,返回的資訊中將error作為鍵名,出錯資訊作為鍵值即可。
{
error: "Invalid API key"
}
8. 返回結果
針對不同操作,伺服器向用戶返回的結果應該符合以下規範。
- GET /collection:返回資源物件的列表(陣列)
- GET /collection/ID:返回單個資源物件(json)
- POST /collection:返回新生成的資源物件(json)
- PUT /collection/ID:返回完整的資源物件(json)
- DELETE /collection/ID:返回一個空文件(空字串)
9. 超媒體(Hypermedia API)
RESTful API最好做到Hypermedia(即返回結果中提供連結,連向其他API方法),使得使用者不查文件,也知道下一步應該做什麼。
比如,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. 其他
伺服器返回的資料格式,應該儘量使用JSON,避免使用XML。
XML是W3C為了替換HTML研發出來的,但是現在很明顯失敗了。
,xml 配置檔案
<xml version="1.0" charset="utf-8">
<name>張三</name>
<sex>男</sex>
<age>18</age>
</xml>
{
“name”:"張三",
"sex":"男",
"age":18
}