Restful API接口規範

1. 域名

應該儘可能將API部署在專用域名之下。html

https://api.example.com

若是肯定API很簡單，不會有進一步擴展，能夠考慮放在主域名下。git

https://example.org/api/

2. 版本（Versioning）

應該將API的版本號放入URL。github

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）：json

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）api

(1) 資源做爲網址，只能有名詞，不能有動詞，並且所用的名詞每每與數據庫的表名對應。數組

舉例來講，如下是很差的例子:服務器

/getProducts
/listOrders
/retreiveClientByOrder?orderId=1

對於一個簡潔結構，你應該始終用名詞。此外，利用的HTTP方法能夠分離網址中的資源名稱的操做。app

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）：從服務器刪除資源。

還有三個不經常使用的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

?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）

服務器向用戶返回的狀態碼和提示信息，常見的有如下一些（方括號中是該狀態碼對應的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 - [*]：服務器發生錯誤，用戶將沒法判斷髮出的請求是否成功。

狀態碼的徹底列表參見這裏或這裏。

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。