django rest_framework開發十大規範

 rest_framework 安裝：

pip3 install djangorestframework -i http://pypi.douban.com/simple/ --trusted-host=pypi.douban.com

 

一：什麼是restful?(軟件架構風格)

• REST與技術無關，表明的是一種軟件架構風格，REST是Representational State Transfer的簡稱，中文翻譯爲「表徵狀態轉移」
• REST從資源的角度類審視整個網絡，它將分佈在網絡中某個節點的資源經過URL進行標識，客戶端應用經過URL來獲取資源的表徵，得到這些表徵導致這些應用轉變狀態
• 全部的數據，無論是經過網絡獲取的仍是操做數據庫得到（增刪改查）的數據，都是資源，將一切數據視爲資源是REST區別與其餘架構風格的最本質屬性
• 對於REST這種面向資源的架構風格，有人提出一種全新的結構理念，即：面向資源架構（ROA：Resource Oriented Architecture）
  • 對互聯網上的任意東西都視爲資源，他認爲一個url就是一個資源 好比：http://www.xxx.com/get_user/

2 什麼是api

是一個接口，經過他能實現先後端分離。前端使用vue 發送ajax請求（axios）

 

3 RESTful API設計 

網絡應用程序，分爲前端和後端兩個部分。當前的發展趨勢，就是前端設備層出不窮（手機、平板、桌面電腦、其餘專用設備......）。

所以，必須有一種統一的機制，方便不一樣的前端設備與後端進行通訊。這致使API構架的流行，甚至出現"API First"的設計思想。RESTful API是目前比較成熟的一套互聯網應用程序的API設計理論。

4 django restframework框架規範：

一：協議：   api與用戶之間的協議，老是要用https協議完成  

二：域名：  儘可能將api佈置在主域名上。

      1 https:// api.example.com    這種可能存在跨域問題，也就是同源（域名，端口，協議），

     解決方法：判斷是簡單請求仍是複雜請求，簡單請求想get，直接("Access-Control-Allow-Origin:http://www.xxx.com")，若是是複雜請求，瀏覽器會先給options，而後在瀏覽器裏面加上相對應的access那段。

 

     2  https:// example.com/api/   若是肯定API很簡單，不會有進一步擴展，能夠考慮放在主域名下

三;版本，應該講把api版本號（v1）放到url中：

     1  htttps://api.example.com/v1/ 

四：路徑

路徑又稱"終點"（endpoint），表示API的具體網址。

在RESTful架構中，每一個網址表明一種資源（resource），因此網址中不能有動詞，只能有名詞，並且所用的名詞每每與數據庫的表格名對應。通常來講，數據庫中的表都是同種記錄的"集合"（collection），因此API中的名詞也應該使用複數。

舉例來講，有一個API提供動物園（zoo）的信息，還包括各類動物和僱員的信息，則它的路徑應該設計成下面這樣。

 

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

五：提交方式（method）

GET:從瀏覽器去除資源（一或多條數據）

POST：從瀏覽器新增資源

PUT:在服務器更新資源（客戶端提供改變後的完整資源）

PUTCH:在服務器更新資源（客戶端提供改變後的屬性）

DELETE:在服務器刪除資源

下面是具體的：

GET（SELECT）：從服務器取出資源（一項或多項）。即獲取數據
POST（CREATE）：在服務器新建一個資源。 即添加數據
PUT（UPDATE）：在服務器更新資源（客戶端提供改變後的完整資源）。即更新數據
PATCH（UPDATE）：在服務器更新資源（客戶端提供改變的屬性）。即更新數據
DELETE（DELETE）：從服務器刪除資源  。即刪除數據

六：過濾：

• 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：指定篩選條件

七：狀態碼

更多詳情：http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

八：返回錯誤信息，若是是4位狀態碼就是錯誤的，把錯誤信息當作key

def get(self,request,*args,**kwargs):
    ret = {
        'code':1000,
        'msg':'xxx'
    }
    # return HttpResponse(json.dumps(ret))
    return HttpResponse(json.dumps(ret), status=201)

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

1 2 3

{     error: "Invalid API key" }

 

 

九：

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

 

 

十：

RESTful API最好作到Hypermedia，即返回結果中提供連接，連向其餘API方法，使得用戶不查文檔，也知道下一步應該作什麼。

好比，當用戶向api.example.com的根目錄發出請求，會獲得這樣一個文檔。

{"link": {
  "rel":   "collection https://www.example.com/zoos",  #表示這個API與當前網址的關係（collection關係，並給出該collection的網址）
  "href":  "https://api.example.com/zoos",  #API路徑
  "title": "List of zoos",  #API的標題
  "type":  "application/vnd.yourformat+json"  #返回類型
}}

Hypermedia API的設計被稱爲HATEOAS。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"
}

 

 

最後歸納：

Django生命週期歸納:

    前端發送請求-->Django的wsgi-->中間件-->路由系統-->視圖-->ORM數據庫操做-->模板-->返回數據給用戶

rest framework生命週期：

    前端發送請求-->Django的wsgi-->中間件-->路由系統_執行CBV的as_view()，就是執行內部的dispath方法-->在執行dispath以前，有版本分析 和 渲染器-->在dispath內，對request封裝-->版本-->認證-->權限-->限流-->視圖-->若是視圖用到緩存( request.data or   request.query_params )就用到了 解析器-->視圖處理數據，用到了序列化(對數據進行序列化或驗證) -->視圖返回數據能夠用到分頁