安装
pip install djangorestframework
在Django项目中使用DRF框架进行开发时,需要将rest_framework在INSTALLED_APPS中进行注册。
INSTALLED_APPS = [
...
'rest_framework',
]
定义serializer
基本形式:
# 模型类定义
from django.db import models
class 模型类名(models.Model):
# 模型类字段 = models.字段类型(选项参数)
# ...
# 序列化器类定义
from rest_framework import serializers
class 序列化器类名(serializers.Serializer):
# 序列化器字段 = serializers.字段类型(选项参数)
# ...
序列化操作
# 创建User对象
user = User(name='smart', age=18)
# 使用UserSerializer将user对象序列化为如下字段数据:{'name': 'smart', 'age': 18}
serializer = UserSerializer(user)
# 获取序列化之后的数据
serializer.data
反序列化操作-数据校验
# 准备数据
data = {
'name': 'admin', 'age': 30}
# 使用UserSerializer对data中的数据进行反序列化校验
serializer = UserSerializer(data=data)
# 调用is_valid进行数据校验,成功返回True,失败返回False
serializer.is_valid()
# 获取校验失败之后的错误提示信息
serializer.errors
# 获取校验通过之后的数据
serializer.validated_data
常用字段类型:
字段 | 字段构造方式 |
---|---|
BooleanField | BooleanField() |
NullBooleanField | NullBooleanField() |
CharField | CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True) |
EmailField | EmailField(max_length=None, min_length=None, allow_blank=False) |
RegexField | RegexField(regex, max_length=None, min_length=None, allow_blank=False) |
SlugField | SlugField(max_length=50, minlength=None, allow_blank=False)正则字段,验证正则模式 [-a-zA-Z0-9-]+ |
URLField | URLField(max_length=200, min_length=None, allow_blank=False) |
UUIDField | UUIDField(format=‘hex_verbose’)format:1) ‘hex_verbose’ 如"5ce0e9a5-5ffa-654b-cee0-1238041fb31a"2 |