DRF基礎操作流程
阿新 • • 發佈：2020-08-11
# 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，建議安裝在虛擬環境
```python
# 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'。
```python
INSTALLED_APPS = [
...
'rest_framework',
]
```
接下來就可以使用DRF提供的功能進行api介面開發了。在專案中如果使用rest_framework框架實現API介面，主要有以下三個步驟：
- 將請求的資料（如JSON格式）轉換為模型類物件
- 操作資料庫
- 將模型類物件轉換為響應的資料（如JSON格式）
## 體驗drf完全簡寫程式碼的過程
### 模型建立
#### 建立模型操作類
```python
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作為資料庫驅動
```python
import pymysql
pymysql.install_as_MySQLdb()
```
#### settings.py配置檔案中配置mysql資料庫資訊
```python
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
註釋掉 python/site-packages/django/backends/mysql/base.py中的35和36行程式碼。
```
###### `python manage.py migrate`時出現的報錯資訊二如圖所示：
###### 解決方法：
backends/mysql/operations.py146行裡面新增一個行程式碼：
### 建立序列化器
例如，在django專案中建立學生子應用。
```python
python manage.py startapp students
```
在students應用目錄中新建serializers.py用於儲存該應用的序列化器。
建立一個StudentModelSerializer用於序列化與反序列化。
```python
# 建立序列化器類，回頭會在試圖中被呼叫
class StudentModelSerializer(serializers.ModelSerializer):
class Meta:
model = Student
fields = "__all__"
```
- **model** 指明該序列化器處理的資料欄位從模型類Student參考生成
- **fields** 指明該序列化器包含模型類中的哪些欄位，'__all__'指明包含所有欄位
### 編寫檢視
在students應用的views.py中建立檢視StudentViewSet，這是一個檢視集合。
```python
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中定義路由資訊。
```python
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子應用中的路由檔案載入到總路由檔案中.
```python
from django.contrib import admin
from django.urls import path,include
urlpatterns = [
path('admin/', admin.site.urls),
path("stu/",include("students.urls")),
]
```
### 執行測試
運行當前程式（與執行Django一樣）
```shell
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按鈕，可以訪問**刪除學生的介面**：
返回，如下頁面：
![](https://img2020.cnblogs.com/blog/2001508/202008/2001508-20200811123633315-17183776