序列化器屬性
官網鏈接：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頁面時，顯示的字段幫助提示信息 | - | - |