Restful架構API編碼規範
阿新 • • 發佈：2018-12-09
accep 一個用戶 命令 offset pat code RoCE 刪除數據 異常處理
Restful API
目前比較成熟的一套互聯網應用程序的API設計理論
一、協議
- API與用戶的通信協議，總是使用HTTPs協議。
二、域名
- 應該盡量將API部署在專用域名之下。
https://api.xxxxxx.cn/https://xxxxxx.cn/api/三、版本（Versioning）
- 應該將API的版本號放入URL。
https://xxxxxx.cn/api/v1/- 另一種做法是，將版本號放在HTTP頭信息中，但不如放入URL方便和直觀。
四、路徑（Endpoint）
- 在RESTful架構中，每個網址代表一種資源（resource），所以網址中不能有動詞，==只能有名詞==，而且所用的名詞往往與數據庫的表格名對應。一般來說，數據庫中的表都是同種記錄的"集合"（collection），所以API中的名詞也應該使用==復數==。
https://xxxxxx.cn/api/v1/users
https://xxxxxx.cn/api/v1/reports
https://xxxxxx.cn/api/v1/jobs- URL中大小寫不敏感，不要出現大寫字母
- _ 和 - 作為API URL連接單詞都可以，但是駝峰命名法就算了
五、HTTP動詞
- 對於資源的具體操作類型，由HTTP動詞表示。
- 常用的HTTP動詞有下面五個（括號裏是對應的SQL命令）。
| HTTP動詞 | 描述 |
|---|---|
| GET（SELECT） | 從服務器取出資源（一項或多項）。 |
| POST（CREATE） | 在服務器新建一個資源。 |
| PUT（UPDATE） | 在服務器更新資源（客戶端提供改變後的完整資源）。 |
| PATCH（UPDATE） | 在服務器更新資源（客戶端提供改變的屬性）。 |
| DELETE（DELETE） | 從服務器刪除資源。 |
GET /users： 列出所有的用戶 POST /users： 新建一個用戶 GET /users/${id}： 獲取某個用戶的信息 PUT /users/${id}： 更新某個用戶的信息（提供該用戶的全部信息） PATCH /users/${id}： 更新某個指定用戶的信息（提供該用戶的部分信息） DELETE /users/${id}： 刪除某個用戶
六、過濾信息（Filtering）
- 如果記錄數量很多，服務器不可能都將它們返回給用戶。API應該提供參數，過濾返回結果。
?limit=10：指定返回記錄的數量
?offset=10：指定返回記錄的開始位置。
?page=2&per_page=100：指定第幾頁，以及每頁的記錄數。
?sortby=name&order=asc：指定返回結果按照哪個屬性排序，以及排序順序。
?user_id=1：指定篩選條件七、狀態碼（Status Codes）
- 服務器向用戶返回的狀態碼和提示信息，常見的有以下一些（方括號中是該狀態碼對應的HTTP動詞）。
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 - [*]：服務器發生錯誤，用戶將無法判斷發出的請求是否成功。八、錯誤處理（Error handling）
- 如果狀態碼是4xx，就應該向用戶返回出錯信息。一般來說，返回的信息中將error作為鍵名，出錯信息作為鍵值即可。
{
error: "Invalid API key"
}- Spring Boot項目中通常需要全局捕獲異常，統一處理。
- Spring全局異常處理並不能處理Filter中的異常。
九、返回結果
- 針對不同操作，服務器向用戶返回的結果應該符合以下規範。
GET /collection：返回資源對象的列表（數組）
GET /collection/resource：返回單個資源對象
POST /collection：返回新生成的資源對象
PUT /collection/resource：返回完整的資源對象
PATCH /collection/resource：返回完整的資源對象
DELETE /collection/resource：返回一個空文檔- 可以自定義返回結果包裝類、返回結果狀態碼和提示信息等。
{
"code":100200,
"msg":"success",
"data":null,
"extra":null
}十、接口安全問題
- API的身份認證應該使用OAuth 2.0框架。
Restful架構API編碼規範