文章目錄
一、RESTFUL API 設計
- API與用戶的通信協議,總是使用HTTPs協議。
- 域名
https://api.example.com
儘量將API部署在專用域名(會存在跨域問題,使用jsonp來解決)https://example.org/api/
API很簡單
- 版本
- URL,如:
https://api.example.com/v1/
- 請求頭 跨域時,引發發送多次請求
- URL,如:
- 路徑,視網絡上任何東西都是資源,均使用名詞表示(可複數)
https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees
- method
GET
:從服務器取出資源(一項或多項)POST
:在服務器新建一個資源PUT
:在服務器更新資源(客戶端提供改變後的完整資源)全部更新PATCH
:在服務器更新資源(客戶端提供改變的屬性)局部更新DELETE
:從服務器刪除資源
- 過濾,通過在url上傳參的形式傳遞搜索條件
https://api.example.com/v1/zoos?limit=10
:指定返回記錄的數量https://api.example.com/v1/zoos?offset=10
:指定返回記錄的開始位置https://api.example.com/v1/zoos?page=2&per_page=100
:指定第幾頁,以及每頁的記錄數https://api.example.com/v1/zoos?sortby=name&order=asc
:指定返回結果按照哪個屬性排序,以及排序順序https://api.example.com/v1/zoos?animal_type_id=1
:指定篩選條件
- 狀態碼
狀態碼與信息結合{“code”:1000,"msg”:“xxx”},
可以與前端商量用狀態碼還是code(自己定義)
# 幾個常用的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 - [*]:服務器發生錯誤,用戶將無法判斷髮出的請求是否成功。
更多看這裏:http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
二、知識點
1. 10個restfull規範,分析記憶
2. 常見重點分析
a. 用過rest framework,那麼寫視圖的時候,都繼承過哪些類?
b. 用過比較接近原生的類,還可以繼承原生的其他子類
c. 哪裏用過面向對象的封裝?
- rest framework中的request就是對Django的request進行的封裝
d. 哪裏用過面向對象的繼承?
- rest_framework的view繼承自APIview
e. 多態、鴨子類型?
- 只要你會鴨子呱呱叫,我就認爲你是鴨子類型
- 只要你含有 .方法 ,都允許
class WX:
def send():
pass
class Email():
def send():
pass
class Msg():
def send():
pass
def func(arg):
arg.send()
obj = Email()
func(obj)
# 只要能send,不管是什麼,都能允許。