# Django Rest_Framework(一)簡(jiǎn)單介紹與安裝

drf_logo.png

核心思想:縮減編寫(xiě)api接口的代碼

Django_Rest_Framework是一個(gè)建立在Django基礎(chǔ)上的Web應(yīng)用開(kāi)發(fā)框架,可以快速的開(kāi)發(fā)REST API接口的應(yīng)用。在REST Framework中,提供了序列化器Serializer的定義,可以幫助我們簡(jiǎn)化序列化和反序列化的過(guò)程,不僅如此,還提供了豐富的類視圖、擴(kuò)展類、視圖集來(lái)簡(jiǎn)化視圖的編寫(xiě)工作。REST Framework還提供了認(rèn)證、權(quán)限、分流、過(guò)濾、分頁(yè)、接口文檔等功能支持。REST framework提供了一個(gè)API的Web可視化潔面來(lái)方便查看測(cè)試接口。

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

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

特點(diǎn):

  1. 提供了定義序列化器Serializer方法,可以快速根據(jù)Django ORM或者其他庫(kù)自動(dòng)序列化/反序列化;

  2. 提供了豐富的類視圖、Mixin擴(kuò)展類。簡(jiǎn)化視圖的編寫(xiě);

  3. 豐富的定制層級(jí):函數(shù)視圖、類視圖、視圖集和到自動(dòng)生成API,買組各種需求;

  4. 多種身份認(rèn)證和權(quán)限認(rèn)證方式的支持;[jwt]

  5. 內(nèi)置了限流系統(tǒng);

  6. 直觀的API web界面;

  7. 可擴(kuò)展性,插件豐富;

安裝預(yù)配置

1.DRF 需要下載的依賴包:

  • Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6)

  • Django(1.10, 1.11, 2.0)

注意:DRF是以Django擴(kuò)展應(yīng)用的方式提供的,所以我們可以直接利用已有的Django換件而無(wú)需從新創(chuàng)建。(若沒(méi)有Django環(huán)境,需要先創(chuàng)建安裝Django)

2.安裝(前提是安裝了python3,virtualenv和virtualenvwrapper管理工具,如果知道那是什么,請(qǐng)移步http://www.itdecent.cn/p/21a9d49970e2

$ mkvirtualenv drfdemo -p python3
$ pip install django
$ pip install djangorestframework
$ pip install pymysql

接下來(lái)我們?cè)囈辉嘍RF簡(jiǎn)單體驗(yàn)一下

一、創(chuàng)建Django項(xiàng)目

$ cd ~/Desktop
$ django-admin startproject drfdemo
1557022536078.png

二、添加REST_framework應(yīng)用

在settings.py的INSTALLED_APPS中添加rest_framework

[圖片上傳失敗...(image-9fae98-1558169869591)]

接下里就可以使用DRF提供的功能進(jìn)行API接口開(kāi)發(fā)了。在項(xiàng)目中如果使用Rest_Framework框架實(shí)現(xiàn)API接口,主要有以下三個(gè)步驟:

  1. 將強(qiáng)求的數(shù)據(jù)(如Json格式)轉(zhuǎn)換為模型類對(duì)象
  2. 操作數(shù)據(jù)庫(kù)
  3. 將模型類對(duì)象轉(zhuǎn)換為相應(yīng)的數(shù)據(jù)(如Json格式)

三、終極體驗(yàn)DRF極簡(jiǎn)模式

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="班級(jí)編號(hào)")    
    description = models.TextField(max_length=1000,verbose_name="個(gè)性簽名")?    
    class Meta:        
        db_table="tb_student"        
        verbose_name = "學(xué)生"                         
        verbose_name_plural = verbose_name
1.1 為了方便測(cè)試,所以我們可以先創(chuàng)建一個(gè)數(shù)據(jù)庫(kù)。(mysql數(shù)據(jù)庫(kù)為例)
1557023744365.png
1.2 把students子應(yīng)用添加到INSTALL_APPS中
image.png
1.3 初始化數(shù)據(jù)庫(kù)連接

安裝pymysql

$ pip install pymysql

主引用中__init__.py設(shè)置使用pymysql作為數(shù)據(jù)庫(kù)驅(qū)動(dòng)

import pymysql

pymysql.install_as_MySQLdb()
image.png

settings.py配置文件中設(shè)置mysql的賬號(hào)密碼

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",
    }
}
1.4 終端下,執(zhí)行數(shù)據(jù)遷移。
$ python manage.py makemigrations
$ python manage.py migrate

此時(shí)你可能遇到如下錯(cuò)誤,別慌:

image.png

解決方案:注釋掉backends/mysql/bash.py中的35和36行代碼。
image.png

再一次進(jìn)行數(shù)據(jù)遷移,然后,wath?。?!,又報(bào)錯(cuò),別慌別慌:
image.png

解決方案:backends/mysql/operations.py146行里面新增一個(gè)行代碼,如圖:
image.png

這樣再遷移一次,完美解決?。。∑鋵?shí)報(bào)這個(gè)錯(cuò)誤的原因是因?yàn)榈谌桨Y源的問(wèn)題,是因?yàn)槲覀僤jango版本比較新,而mysql的一些包需要升級(jí)了,我們也可以把我們的django版本降低。但是我這樣解決也問(wèn)題不大。視需求而定吧。

2.創(chuàng)建序列化器
$ python manage.py startapp students

在students應(yīng)用目錄中新建serializers.py用于保存該應(yīng)用的序列化器。
創(chuàng)建一個(gè)StudentModelSerializer用于序列化與反序列化。

from rest_framework import serializers
from .models import Students
# 創(chuàng)建序列化器類, 以供視圖中使用
class StudentModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = Student
        fields = "__all__"
  • model指明該序列化器處理的字段從模型類Student中生成
  • fields指明該序列化器包含模型類中的那些字段,"all"指明包含所有字段
3.編寫(xiě)視圖

在students應(yīng)用的views.py中創(chuàng)建視圖StudentViewSet,這是一個(gè)視圖集合。

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指明該視圖集在查詢數(shù)據(jù)時(shí)使用的查詢集
  • serializer_class指明該視圖在記性序列化或者反序列化時(shí)使用的序列化器
4.定義路由

在students應(yīng)用的urls.py中定義路由信息

from . import views
from rest_framework.routers import DefaultRouter

urlpatterns = []  # 路由列表
router = DefaultRouter()  # 可以處理視圖的路由器
router.register('students', views.StudentViewSet)  # 向路由器中注冊(cè)視圖集
urlpatterns += router.urls  # 將路由器中的所有路由信息追加到Django的路由列表中

最后把students子應(yīng)用中的路由文件加載到總路由文件中

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

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

最后,運(yùn)行一下,看看效果吧

(注意在項(xiàng)目根部錄下運(yùn)行,也及時(shí)manage.py文件所在路徑)

$ python manage.py runserver

在瀏覽器中輸入網(wǎng)址127.0.0.1:8000,可以看到DRF提供的API Web瀏覽頁(yè)面:

image.png

1)點(diǎn)擊鏈接127.0.0.1:8000/stu/students 可以訪問(wèn)獲取所有數(shù)據(jù)的接口,呈現(xiàn)如下頁(yè)面:
image.png

2)在頁(yè)面底下表單部分填寫(xiě)學(xué)生信息,可以訪問(wèn)添加新學(xué)生的接口,保存學(xué)生信息:
image.png

點(diǎn)擊POST后,返回如下頁(yè)面信息:
image.png

3)在瀏覽器中輸入網(wǎng)址127.0.0.1:8000/stu/students/5/,可以訪問(wèn)獲取單一學(xué)生信息的接口(id為5的學(xué)生),呈現(xiàn)如下頁(yè)面:
image.png

4)在頁(yè)面底部表單中填寫(xiě)學(xué)生信息,可以訪問(wèn)修改學(xué)生的接口
image.png

點(diǎn)擊PUT,返回如下頁(yè)面信息:

image.png

5)點(diǎn)擊DELETE按鈕,可以訪問(wèn)刪除學(xué)生的接口
image.png

返回,如下頁(yè)面:
image.png

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容