5 分钟，带你快速入门 Django DRF
5 分钟，带你快速入门 Django DRF
1. 前言
大家好，我是安果！
DRF 框架，全称为 Django Rest Framework，是 Django 内置模块的扩展，用于创建标准化 RESTful API；它利用 ORM 映射数据库，并自定义序列化数据进行返回，多用于前后端分离项目
项目地址：
https://github.com/encode/django-rest-framework
本篇文章将带大家 5 分钟快速入门 DRF
2. 实现步骤
详细使用步骤如下（ 10 步）
2-1 创建虚拟环境
使用 mkvirtualenv 创建一个单独的虚拟环境，指定 Python 版本为 3.7
# 创建虚拟环境，名称为：django3
# 以 Python3.7 创建
mkvirtualenv --python=python3.7 django3
2-2 安装依赖包
接着，进入虚拟环境，安装依赖包「 djangorestframework 」
# 进入虚拟环境
workon django3
# 安装依赖django
pip3 install django
# 安装依赖djangorestframework
pip3 install djangorestframework
2-3 创建项目
打开目标文件夹目录，使用「 django-admin startproject 」命令创建一个 Django 项目
# 创建一个django项目
# 项目名称：drf_demo
django-admin startproject drf_demo
2-4 数据库映射及超级用户创建
打开 Pycharm，在项目根目录下，进入虚拟环境，使用内置的「 sqlite 」进行数据库映射，并创建一个超级用户
# 进入虚拟环境
workon django3
# 数据库映射（sqlite3）
python3 manage.py migrate
# 创建一个超级用户，记住用户名和密码
python3 manage.py createsuperuser
2-5 添加应用并配置 DRF 权限
在项目配置文件 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 权限
# 配置DRF权限
REST_FRAMEWORK = {
'DEFAULT_PERMISSION_CLASSES': [
'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly',
]
}
2-6 自定义序列化类并关联模型
在项目目录下的 urls.py 文件中，自定义一个类继承于「 serializers.HyperlinkedModelSerializer 」
利用内部类「 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 的表现
2-7 定义视图 ViewSets
在 urls.py 文件中，定义一个视图表现类，让他继承于「 viewsets.ModelViewSet 」类
# urls.py
from django.contrib.auth.models import User
# 自定义定义视图表现
class UserViewSet(viewsets.ModelViewSet):
# 查询所有数据
queryset = User.objects.all()
# 指定序列化对应的类
serializer_class = UserSerializer
其中
queryset指定数据源serializer_class指定要序列化的类，即上面自定义的序列化类：UserSerializer2-8 注册路由
同样在 urls.py 文件中，使用 DRF 的 DefaultRouter() 函数实例化一个 router 对象
然后，通过 register() 函数将上面自定义的视图 UserViewSet 注册到路由中去
# urls.py
from rest_framework import serializers, viewsets, routers
# 注册路由
router = routers.DefaultRouter()
router.register(r'users', UserViewSet)
2-9 定义 URL
在 urls.py 文件中，在数组 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/
接着，点击界面右上角的登录，使用超级用户进行登录后
如此，就完成了一个简单 RESTful API 的构建
3. 最后
文中介绍了快速入门 DRF 的基本流程，实际项目中，一般将序列化、视图类单独分离出来
另外，序列化、视图函数、API 可以根据父类去自由定制，这部分内容下篇文章再进行说明