1.使用Serializer方法自己创建一个序列化器
先写一个简单的例子
class BookInfoSerializer(serializers.Serializer): """个人信息序列化器""" id = serializers.IntegerField(label='ID', read_only=True) name = serializers.CharField(label='姓名', max_length=20) birthday = serializers.DateField(label='生日', required=False) fanscount = serializers.IntegerField(label='粉丝数量', required=False) image = serializers.ImageField(label='头像', required=False)
这就是一个简单的序列化器,界限来我们简单的介绍相关的字段
常用字段类型:
字段 | 字段构造方式 |
---|---|
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(maxlength=50, min_length=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)'hex' 如"5ce0e9a55ffa654bcee01238041fb31a" 3)'int' - 如:"123456789012312313134124512351145145114" 4)'urn' 如:"urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a" |
IPAddressField | IPAddressField(protocol='both', unpack_ipv4=False, **options) |
IntegerField | IntegerField(max_value=None, min_value=None) |
FloatField | FloatField(max_value=None, min_value=None) |
DecimalField | DecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None) max_digits: 最多位数 decimal_palces: 小数点位置 |
DateTimeField | DateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None) |
DateField | DateField(format=api_settings.DATE_FORMAT, input_formats=None) |
TimeField | TimeField(format=api_settings.TIME_FORMAT, input_formats=None) |
DurationField | DurationField() |
ChoiceField | ChoiceField(choices) choices与Django的用法相同 |
MultipleChoiceField | MultipleChoiceField(choices) |
FileField | FileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL) |
ImageField | ImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL) |
ListField | ListField(child=, min_length=None, max_length=None) |
DictField | DictField(child=) |
一些相关的参数说明:
选项参数:
参数名称 | 作用 |
---|---|
max_length | 最大长度 |
min_lenght | 最小长度 |
allow_blank | 是否允许为空 |
trim_whitespace | 是否截断空白字符 |
max_value | 最大值 |
min_value | 最小值 |
通用参数:
参数名称 | 说明 |
---|---|
read_only | 表明该字段仅用于序列化输出,默认False |
write_only | 表明该字段仅用于反序列化输入,默认False |
required | 表明该字段在反序列化时必须输入,默认True |
default | 反序列化时使用的默认值 |
allow_null | 表明该字段是否允许传入None,默认False |
validators | 该字段使用的验证器 |
error_messages | 包含错误编号与错误信息的字典 |
label | 用于HTML展示API页面时,显示的字段名称 |
help_text | 用于HTML展示API页面时,显示的字段帮助提示信息 |
这样我们就可以根据自己的需求去生成我们自己的序列化器
2.使用ModelSerializer创建序列化器
也许你会感觉创建序列化器太麻烦了,接下来将要介绍一种特别简单的方式来创建一个序列化器
class BookInfoSerializer(serializers.ModelSerializer): class Meta: model = 数据类名 fields = '__all__'
到此我们已经创建完成了,但要达成我们的要求还需要进行一些简单的设计,接下来会将一些用法告诉大家
1) 使用fields来明确字段,__all__
表名包含所有字段,也可以写明具体哪些字段
2) 使用exclude可以明确排除掉哪些字段
3) 指明只读字段可以通过read_only_fields指明只读字段,即仅用于序列化输出的字段
4) 添加额外参数我们可以使用extra_kwargs参数为ModelSerializer添加或修改原有的选项参数
具体就不举例子了(太多了)
看完在中方式是不是感觉特别简单?但这中方式必须要有model类,如果没有model类是不能使用这种方式的,我们可以根据需求去选取方法