Restful

一、協定

API與使用者的通信協定，總是使用HTTPS協定

二、域名

應該盡量将API部署在專用域名下

https://api.example.com      

如果确定API很簡單，不會有進一步擴充，可以考慮放在主域名下。

https://example.org/api/      

三、版本

應該将API的版本号放入URL

https://api.example.com/v1/      

四、路徑

路徑又稱為“終點”，表示API的具體網址

在RESTFUL架構中，每個網址代表一種資源，所有網址不能有動詞，隻能有名詞，而且名詞往往和資料庫的表名對應。

舉例來說，有個API提供動物園的資訊

https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees      

五、HTTP動詞

對于資源的具體操作類型，有HTTP動詞表示

常用的HTTP動詞有下面五個（括号裡是對應的SQL指令）

• GET(SELECT)：從伺服器取出資源（一項或多項）
• POST(CREATE)：從伺服器建立一個資源
• PUT(UPDATE)：在伺服器更新資源（用戶端提供改變後的完整資源）
• PATCH(UPDATE)：在伺服器更新資源（用戶端提供改變的屬性）
• DELETE(DELETE)：從伺服器删除資源

還有倆個不常用的HTTP動詞

• HEAD：擷取資源的中繼資料
• OPTIONS：擷取資訊，關于資源的哪些屬性是用戶端可以改變的

六、過濾資訊

如果記錄數量很多，API應該提供參數，過濾傳回結果

?limit=10：指定傳回記錄的數量
?offset=10：指定傳回記錄的開始位置。
?page=2&per_page=100：指定第幾頁，以及每頁的記錄數。
?sortby=name&order=asc：指定傳回結果按照哪個屬性排序，以及排序順序。
?animal_type_id=1：指定篩選條件      

七、狀态碼

伺服器向使用者傳回的狀态碼和提示資訊

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 - [*]：伺服器發生錯誤，使用者将無法判斷發出的請求是否成功。      

八、錯誤處理

如果狀态碼是4XX，就該向使用者傳回出錯資訊。一般來說，傳回資訊中講error作為鍵名，出錯資訊作為鍵值即可

{
    error: "Invalid API key"
}      

九、傳回結果

針對不同操作，伺服器向使用者傳回的結果應該符合以下規範

GET /collection：傳回資源對象的清單（數組）
GET /collection/resource：傳回單個資源對象
POST /collection：傳回新生成的資源對象
PUT /collection/resource：傳回完整的資源對象
PATCH /collection/resource：傳回完整的資源對象
DELETE /collection/resource：傳回一個空文檔      

十、Hypermedia API

RESTful API最好做到Hypermedia，即傳回結果中提供連結，聯向其他API方法，是使用者不查文檔就知道下一步該做什麼

十一、其他

API的身份認證應該使用OAuth架構

伺服器傳回的資料格式，應該使用JSON