第一篇：DRF之介紹與簡單使用

• 第一篇：DRF之介紹與簡單使用
  • 一、web開發模式
    • 1、前後端不分離
    • 2、前後端分離
  • 二、api介面
  • 三、postman使用
  • 四、RESTful規範【重點】
  • 五、drf的安裝和簡單使用

一、web開發模式

1、前後端不分離

我們以前的django專案，html頁面是在後端進行模板的渲染，之後再返回給前端一個完整的html頁面。【js程式碼除外，需要在瀏覽器進行渲染，所以js程式碼中不建議使用模板語法】。具體的流程如下。

2、前後端分離

隨著發展，前後端不分離的專案已經不能滿足一些相應的要求，所以便有了前後端分離的設計模式。

後端程式設計師只需要專注於寫後端介面，返回給前端json、xml格式的資料即可，前後端使用json、xml格式進行互動。

# xml格式
<xml>
	<name>yangyi</name>
</xml>

# json
{"name":"yangyi"}

每門語言都有其web框架，返回其相應的頁面。
# java ---> jsp
類似於 https://www.pearvideo.com/category_loading.jsp
# php
類似於 http://www.aa7a.cn/user.php
# python
類似於 http://www.aa7a.cn/user  【也可以.html，作成偽靜態頁面】
    
"""動靜態頁面區分""" 
動態頁面（查資料庫的）
靜態頁面（靜止的html）
 

二、api介面

為了達成統一，避免因為個人的習慣差異而引起的混亂，我們需要使用一種大家都約定俗成去遵循的介面實現規範，並且這種規範能夠讓後端寫的介面，用途一目瞭然。

通過網路，規定了前後臺資訊互動規則的url連結，也就是前後臺資訊互動的媒介。

"""四大特性"""
1 url: 長得像返回資料的url連線
2 請求方式: get、post、put、patch、delete
3 請求引數: json或xml格式的key-value鍵值對
4 響應結果: json或xml格式的資料

我們使用下面的路徑進行測試，做一個簡單的案例。

https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E6%BE%84%E5%9F%8E%E5%8E%BF&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=json
 

當然，也可以返回xml格式的資料。

https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E6%BE%84%E5%9F%8E%E5%8E%BF&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=xml

三、postman使用

簡單來說，postman就是一個模擬傳送http請求的工具。

我們將剛才使用的路徑使用postman進行測試，效果如下。

具體方式如下。

解析json的網站

好了，我們接著簡單看一下，請求頭中的資料。

postman還支援批量匯入和匯入介面。

# 匯出
Collections ---> Export
# 匯入
Collections ---> import

post解析json格式時，中文不存在亂碼問題。

四、RESTful規範【重點】

REST全稱是Representational State Transfer，中文意思是表述（編者注：通常譯為表徵性狀態轉移）。 它首次出現在2000年Roy Fielding的博士論文中。

RESTful是一種定義Web API介面的設計風格，尤其適用於前後端分離的應用模式中。

這種風格的理念認為後端開發任務就是提供資料的，對外提供的是資料資源的訪問介面，所以在定義介面時，客戶端訪問的URL路徑就表示這種要操作的資料資源。

事實上，我們可以使用任何一個框架都可以實現符合restful規範的API介面。

"""10條規範"""
1  資料的安全保障：url連結一般都採用https協議進行傳輸 注：採用https協議，可以提高資料互動過程中的安全性。
2 介面特徵表現，一看就知道是個api介面
    - 用api關鍵字標識介面url：
    - [https://api.baidu.com](https://api.baidu.com/)
    - https://www.baidu.com/api
        注：看到api字眼，就代表該請求url連結是完成前後臺數據互動的
        -路飛的介面：https://api.luffycity.com/api/v1/course/free/
3 多資料版本共存
    - 在url連結中標識資料版本
    - https://api.baidu.com/v1
    - https://api.baidu.com/v2
    注：url連結中的v1、v2就是不同資料版本的體現（只有在一種資料資源有多版本情況下）
4 資料即是資源，均使用名詞（可複數）
    - 介面一般都是完成前後臺數據的互動，互動的資料我們稱之為資源
      - https://api.baidu.com/users
      - https://api.baidu.com/books
      - https://api.baidu.com/book     
      注：一般提倡用資源的複數形式，在url連結中獎勵不要出現操作資源的動詞，錯誤示範：https://api.baidu.com/delete-user
    - 特殊的介面可以出現動詞，因為這些介面一般沒有一個明確的資源，或是動詞就是介面的核心含義
    - https://api.baidu.com/place/search
    - https://api.baidu.com/login
5 資源操作由請求方式決定（method）
    - 操作資源一般都會涉及到增刪改查，我們提供請求方式來標識增刪改查動作
      - https://api.baidu.com/books - get請求：獲取所有書
      - https://api.baidu.com/books/1 - get請求：獲取主鍵為1的書
      - https://api.baidu.com/books - post請求：新增一本書書
      - https://api.baidu.com/books/1 - put請求：整體修改主鍵為1的書
      - https://api.baidu.com/books/1 - patch請求：區域性修改主鍵為1的書
      - https://api.baidu.com/books/1 - delete請求：刪除主鍵為1的書
6 過濾，通過在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：指定篩選條件
7 響應狀態碼
   7.1 正常響應
    - 響應狀態碼2xx
      - 200：常規請求
      - 201：建立成功
   7.2 重定向響應
    - 響應狀態碼3xx
      - 301：永久重定向
      - 302：暫時重定向
   7.3 客戶端異常
    - 響應狀態碼4xx
      - 403：請求無許可權
      - 404：請求路徑不存在
      - 405：請求方法不存在
	7.4 伺服器異常
    - 響應狀態碼5xx
      - 500：伺服器異常 
8 錯誤處理，應返回錯誤資訊，error當做key
    {
        error: "無許可權操作"
    }
 9 返回結果，針對不同操作，伺服器向用戶返回的結果應該符合以下規範
    GET /collection：返回資源物件的列表（陣列）
    GET /collection/resource：返回單個資源物件
    POST /collection：返回新生成的資源物件
    PUT /collection/resource：返回完整的資源物件
    PATCH /collection/resource：返回完整的資源物件
    DELETE /collection/resource：返回一個空文件
 10 需要url請求的資源需要訪問資源的請求連結
     # Hypermedia API，RESTful API最好做到Hypermedia，即返回結果中提供連結，連向其他API方法，使得使用者不查文件，也知道下一步應該做什麼
        {
            "status": 0,
            "msg": "ok",
            "results":[
                {
                    "name":"肯德基(羅餐廳)",
                    "img": "https://image.baidu.com/kfc/001.png"
                }
                ...
                ]
        }

五、drf的安裝和簡單使用

我們使用如下方式進行安裝。

pip3 install djangorestframework==3.10.3