DRF基礎操作流程

Django Rest_Framework

核心思想: 縮減編寫api接口的代碼 ——>DRF

Django REST framework是一個建立在Django基礎之上的Web 應用開發框架，可以快速的開發REST API接口應用。在REST framework中，提供了序列化器serializers的定義，可以幫助我們簡化序列化與反序列化的過程，不僅如此，還提供豐富的類視圖、擴展類、視圖集來簡化視圖的編寫工作。REST framework還提供了認證、權限、限流、過濾、分頁、接口文檔等功能支持。REST framework提供了一個API 的Web可視化界面來方便查看測試接口。

中文文檔：https://q1mi.github.io/Django-REST-framework-documentation/#django-rest-framework

github: https://github.com/encode/django-rest-framework/tree/master

英文文檔：https://www.django-rest-framework.org/

特點

• 提供了定義序列化器Serializer的方法，可以快速根據 Django ORM 或者其它庫自動序列化/反序列化；
• 提供了豐富的類視圖、Mixin擴展類，簡化視圖的編寫；
• 豐富的定制層級：函數視圖、類視圖、視圖集合到自動生成 API，滿足各種需要；
• 多種身份認證和權限認證方式的支持；[jwt]
• 內置了限流系統；
• 直觀的 API web 界面；
• 可擴展性，插件豐富

環境安裝與配置

DRF需要以下依賴：

• Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6)
• Django (1.10, 1.11, 2.0)

DRF是以Django擴展應用的方式提供的，所以我們可以直接利用已有的Django環境而無需從新創建。（若沒有Django環境，需要先創建環境安裝Django）

安裝DRF

前提是已經安裝了django，建議安裝在虛擬環境

# mkvirtualenv drfdemo -p python3
# pip install django

pip install djangorestframework

創建django項目

cd ~/Desktop

django-admin startproject drfdemo

使用pycharm打開項目，設置虛擬環境的解析器，並修改manage.py中的后綴參數。

添加rest_framework應用

在settings.py的INSTALLED_APPS中添加'rest_framework'。

INSTALLED_APPS = [
    ...
    'rest_framework',
]

基於django基礎配置上的drf框架的配置信息

在settings.py中進行如下設置：

REST_FRAMEWORK = {
    'DEFAULT_SCHEMA_CLASS': "rest_framework.schemas.AutoSchema",
    
    # 默認響應渲染類
    'DEFAULT_RENDERER_CLASSES': (  
        'rest_framework.renderers.JSONRenderer',  # json渲染器
        'rest_framework.renderers.BrowsableAPIRenderer',  # 瀏覽器API渲染器
    ),
    
    ...
}
    

接下來就可以使用DRF提供的功能進行api接口開發了。在項目中如果使用rest_framework框架實現API接口，主要有以下三個步驟：

• 將請求的數據（如JSON格式）轉換為模型類對象
• 操作數據庫
• 將模型類對象轉換為響應的數據（如JSON格式）

體驗drf完全簡寫代碼的過程

模型創建

創建模型操作類

class Student(models.Model):
    # 模型字段
    name = models.CharField(max_length=100,verbose_name="姓名",help_text='提示文本：不能為空')
    sex = models.BooleanField(default=1,verbose_name="性別")
    age = models.IntegerField(verbose_name="年齡")
    class_null = models.CharField(max_length=5,verbose_name="班級編號")
    description = models.TextField(max_length=1000,verbose_name="個性簽名")

    class Meta:
        db_table="tb_student"
        verbose_name = "學生"
        verbose_name_plural = verbose_name

創建一個數據庫。

create database students charset=utf8;

執行數據遷移

把students子應用添加到INSTALL_APPS中

初始化數據庫連接

安裝pymysql

pip install pymysql

主應用中__init__.py設置使用pymysql作為數據庫驅動

import pymysql

pymysql.install_as_MySQLdb()

settings.py配置文件中配置mysql數據庫信息

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': "students",
        "HOST": "127.0.0.1",
        "PORT": 3306,
        "USER": "root",
        "PASSWORD":"123",
    }
}

終端下，執行數據遷移。

python manage.py makemigrations

python manage.py migrate

執行數據遷移時：

python manage.py makemigrations時出現的報錯信息一如圖所示：

解決方案：

注釋掉 python/site-packages/django/backends/mysql/base.py中的35和36行代碼。

python manage.py migrate時出現的報錯信息二如圖所示：

解決方法：

backends/mysql/operations.py146行里面新增一個行代碼：

創建序列化器

例如，在django項目中創建學生子應用。

python manage.py startapp students

在students應用目錄中新建serializers.py用於保存該應用的序列化器。

創建一個StudentModelSerializer用於序列化與反序列化。

# 創建序列化器類，回頭會在試圖中被調用
class StudentModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = Student
        fields = "__all__"

• model 指明該序列化器處理的數據字段從模型類Student參考生成
• fields 指明該序列化器包含模型類中的哪些字段，'all'指明包含所有字段

編寫視圖

在students應用的views.py中創建視圖StudentViewSet，這是一個視圖集合。

from rest_framework.viewsets import ModelViewSet
from .models import Student
from .serializers import StudentModelSerializer
# Create your views here.
class StudentViewSet(ModelViewSet):
    queryset = Student.objects.all() 
    serializer_class = StudentModelSerializer

• queryset 指明該視圖集在查詢數據時使用的查詢集
• serializer_class 指明該視圖在進行序列化或反序列化時使用的序列化器

定義路由

在students應用的urls.py中定義路由信息。

from . import views
from rest_framework.routers import DefaultRouter

# 路由列表
urlpatterns = []

router = DefaultRouter()  # 可以處理視圖的路由器，自動通過視圖來生成增刪改查的url路徑
router.register('students', views.StudentViewSet)  #students是生成的url前綴，名稱隨便寫， 向路由器中注冊視圖集

urlpatterns += router.urls  # 將路由器中的所以路由信息追到到django的路由列表中

最后把students子應用中的路由文件加載到總路由文件中.

from django.contrib import admin
from django.urls import path,include

urlpatterns = [
    path('admin/', admin.site.urls),
    path("stu/",include("students.urls")),
]

運行測試

運行當前程序（與運行Django一樣）

python manage.py runserver

在瀏覽器中輸入網址127.0.0.1:8000，可以看到DRF提供的API Web瀏覽頁面：

1）點擊鏈接127.0.0.1:8000/stu/students 可以訪問獲取所有數據的接口，呈現如下頁面：

2）在頁面底下表單部分填寫學生信息，可以訪問添加新學生的接口，保存學生信息：

點擊POST后，返回如下頁面信息：

3）在瀏覽器中輸入網址127.0.0.1:8000/stu/students/5/，可以訪問獲取單一學生信息的接口（id為5的學生），呈現如下頁面：

4）在頁面底部表單中填寫學生信息，可以訪問修改學生的接口：

點擊PUT，返回如下頁面信息：

5）點擊DELETE按鈕，可以訪問刪除學生的接口：

返回，如下頁面：