大家好,我是安果!
DRF 框架,全稱為 Django Rest Framework,是 Django 內(nèi)置模塊的擴展,用于創(chuàng)建標準化 RESTful API;它利用 ORM 映射數(shù)據(jù)庫,并自定義序列化數(shù)據(jù)進行返回,多用于前后端分離項目
項目地址:
https://github.com/encode/django-rest-framework
本篇文章將帶大家 5 分鐘快速入門 DRF
詳細使用步驟如下( 10 步)
2-1 創(chuàng)建虛擬環(huán)境
使用 mkvirtualenv 創(chuàng)建一個單獨的虛擬環(huán)境,指定 Python 版本為 3.7
# 創(chuàng)建虛擬環(huán)境,名稱為:django3
# 以 Python3.7 創(chuàng)建
mkvirtualenv --python=python3.7 django3
2-2 安裝依賴包
接著,進入虛擬環(huán)境,安裝依賴包「 djangorestframework 」
# 進入虛擬環(huán)境
workon django3
# 安裝依賴django
pip3 install django
# 安裝依賴djangorestframework
pip3 install djangorestframework
2-3 創(chuàng)建項目
打開目標文件夾目錄,使用「 django-admin startproject 」命令創(chuàng)建一個 Django 項目
# 創(chuàng)建一個django項目
# 項目名稱:drf_demo
django-admin startproject drf_demo
2-4 數(shù)據(jù)庫映射及超級用戶創(chuàng)建
打開 Pycharm,在項目根目錄下,進入虛擬環(huán)境,使用內(nèi)置的「 sqlite 」進行數(shù)據(jù)庫映射,并創(chuàng)建一個超級用戶
# 進入虛擬環(huán)境
workon django3
# 數(shù)據(jù)庫映射(sqlite3)
python3 manage.py migrate
# 創(chuàng)建一個超級用戶,記住用戶名和密碼
python3 manage.py createsuperuser
2-5 添加應用并配置 DRF 權(quán)限
在項目配置文件 settings.py 中,添加應用「 rest_framework 」
# settings.py
# 添加應用:rest_framework
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'rest_framework',
]
然后配置 REST_FRAMEWORK 權(quán)限
# 配置DRF權(quán)限
REST_FRAMEWORK = {
'DEFAULT_PERMISSION_CLASSES': [
'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly',
]
}
2-6 自定義序列化類并關(guān)聯(lián)模型
在項目目錄下的 urls.py 文件中,自定義一個類繼承于「 serializers.HyperlinkedModelSerializer 」
利用內(nèi)部類「 Meta 」指定模型和要序列化的屬性
# urls.py
# 序列化
from django.contrib import admin
from django.contrib.auth.models import User
from django.urls import path
# 自定義序列化類
from rest_framework import serializers
class UserSerializer(serializers.HyperlinkedModelSerializer):
class Meta:
model = User
fields = ['url', 'username', 'email', 'is_staff']
PS:序列化用于定義 API 的表現(xiàn)
2-7 定義視圖 ViewSets
在 urls.py 文件中,定義一個視圖表現(xiàn)類,讓他繼承于「 viewsets.ModelViewSet 」類
# urls.py
from django.contrib.auth.models import User
# 自定義定義視圖表現(xiàn)
class UserViewSet(viewsets.ModelViewSet):
# 查詢所有數(shù)據(jù)
queryset = User.objects.all()
# 指定序列化對應的類
serializer_class = UserSerializer
其中
queryset
指定數(shù)據(jù)源
2-8 注冊路由
同樣在 urls.py 文件中,使用 DRF 的 DefaultRouter() 函數(shù)實例化一個 router 對象
然后,通過 register() 函數(shù)將上面自定義的視圖 UserViewSet 注冊到路由中去
# urls.py
from rest_framework import serializers, viewsets, routers
# 注冊路由
router = routers.DefaultRouter()
router.register(r'users', UserViewSet)
2-9 定義 URL
在 urls.py 文件中,在數(shù)組 urlpatterns 中定義 URL
# urls.py
from django.urls import path, include
urlpatterns = [
path('admin/', admin.site.urls),
# 定義URL
path('', include(router.urls)),
path('api-auth/', include('rest_framework.urls', namespace='rest_framework')),
]
2-10 API 管理及測試
運行項目,瀏覽器訪問下面的地址
http://127.0.0.1:8000/
聯(lián)系客服