Django序列化器的类型和选项

序列化器属性

官网链接:http://www.django-rest-framework.org/api-guide/fields/

字段 字段构造方式
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 是否允许为空字符串 是否允许为空字符串 False
trim_whitespace 是否截掉空白字符 True
max_value 最大值
min_value 最小值

3. 通用选项

参数名称 说明 默认值 何时使用
read_only 表明该字段仅用于序列化输出:(例:主键 id) False 序列化
write_only 表明该字段仅用于反序列化输入(例:短信验证码) False 反序列化
required 表明该字段在反序列化时必须输入 True 反序列化
allow_null 表明该字段是否允许传入None False 反序列化
default 反序列化时使用的默认值 - 反序列化
validators 该字段使用的验证器 - 反序列化
error_messages 包含错误编号与错误信息的字典 - -
label 用于HTML展示API页面时,显示的字段名称 - -
help_text 用于HTML展示API页面时,显示的字段帮助提示信息 - -
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章