RESTful API規範

'''1. 2XX請求成功'''
# 200 請求成功，通常用於GET與POST請求
# 201 Created - [POST/PUT/PATCH]：用戶新建或修改數據成功。
# 202 Accepted - [*]：表示一個請求已經進入後臺排隊（異步任務）
# 204 NO CONTENT - [DELETE]：用戶刪除數據成功。
'''2. 3XX重定向'''
# 301 NO CONTENT - 永久重定向
# 302 NO CONTENT - 臨時重定向
'''3. 4XX客戶端錯誤'''
# 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] 當建立一個對象時，發生一個驗證錯誤。
'''4. 5XX服務端錯誤'''
# 500 INTERNAL SERVER ERROR - [*]：服務器內部錯誤，沒法完成請求
# 501 Not Implemented     服務器不支持請求的功能，沒法完成請求

更多狀態碼參考：https://www.runoob.com/http/http-status-codes.html

八、錯誤處理，狀態碼是4xx時，應返回錯誤信息，error當作key

{ 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方法，使得用戶不查文檔，也知道下一步應該作什麼

{"link": {
  "rel":   "collection https://www.example.com/zoos",
  "href":  "https://api.example.com/zoos",
  "title": "List of zoos",
  "type":  "application/vnd.yourformat+json"
}}

demo