Django Rest_Framework

時間 2019-11-16

原文原文鏈接

目錄python

簡介

核心思想: 縮減編寫api接口的代碼mysql

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

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

GitHub：https://github.com/encode/django-rest-framework/tree/masterweb

特色

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

環境安裝與配置

安裝依賴

DRF須要如下依賴：sql

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）數據庫

安裝

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

# mkvirtualenv drfdemo -p python3    # 建立虛擬環境， -p指定解釋器
# pip install django

pip install djangorestframework
pip install pymysql

建立Django項目

cd ~/Desktop
django-admin startproject drfdemo

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

使用DRF

註冊rest_framework應用

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

INSTALLED_APPS = [
    ...
    'rest_framework',
]

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

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

建立子應用

建立一個子應用student並註冊

建立模型類

在student.models裏面寫入以下代碼

class Student(models.Model):
    # 模型字段
    name = models.CharField(max_length=100,verbose_name="姓名")
    sex = models.BooleanField(default=1,verbose_name="性別")
    age = models.IntegerField(verbose_name="年齡")
    class_num = models.CharField(max_length=5,verbose_name="班級編號")
    description = models.TextField(max_length=1000,verbose_name="個性簽名")

    class Meta:
        db_table="tb_student"    # 指定表名，不指定時會默認以app名_model名來命名
        verbose_name = "學生"
        verbose_name_plural = verbose_name

建立數據庫

create database students charset=utf8;

配置數據庫

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

import pymysql

pymysql.install_as_MySQLdb()

setting.py裏更改DATABASES設置

DATABASES = {
    # 'default': {
    #     'ENGINE': 'django.db.backends.sqlite3',
    #     'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
    # },
    '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時報錯

解決方案：
註釋掉 backends/mysql/base.py中的35和36行代碼。

繼續遷移，又報錯

解決方案
backends/mysql/operations.py146行裏面新增一個行代碼：

建立序列化器

在student目錄下面新建一個serializers.py用於保存改應用的序列化器

在serializers.py裏建立一個StudentModelSerializer用於序列化和反序列化

# 建立序列化器類，回頭會在視圖中被調用
class StudentModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = Student    # 指定要操做的Model
        fields = "__all__"    # 序列化全部字段，即返回的數據中包含全部student的字段

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

編寫視圖

在studnet.views裏面建立視圖集，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()  # 能夠處理視圖的路由器
router.register('students', views.StudentViewSet)  # 向路由器中註冊視圖集

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

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

在drfdemo.urls.py裏面

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

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