官方文檔：https://www.django-rest-framework.org/
GitHub源碼：https://github.com/encode/django-rest-framework/tree/master
1. 安裝DRF
pip install djangorestframework
2. 添加rest_framework應用
我們利用在Django架構學習中建立的demo工程，在settings.py的INSTALLED_APPS中添加'rest_framework'。
INSTALLED_APPS = [
...
'rest_framework',
]
接下來就可以使用DRF進行開發了。
定義Serializer
1. 定義方法
Django REST framework中的Serializer使用類來定義，須繼承自rest_framework.serializers.Serializer。
例如，我們已有了一個資料庫模型類BookInfo
class BookInfo(models.Model):
btitle = models.CharField(max_length=20, verbose_name='名稱')
bpub_date = models.DateField(verbose_name='釋出日期', null=True)
bread = models.IntegerField(default=0, verbose_name='閱讀量')
bcomment = models.IntegerField(default=0, verbose_name='評論量')
image = models.ImageField(upload_to='booktest', verbose_name='圖檔', null=True)
我們想為這個模型類提供一個序列化器，可以定義如下：
class BookInfoSerializer(serializers.Serializer):
"""圖書資料序列化器"""
id = serializers.IntegerField(label='ID', read_only=True)
btitle = serializers.CharField(label='名稱', max_length=20)
bpub_date = serializers.DateField(label='釋出日期', required=False)
bread = serializers.IntegerField(label='閱讀量', required=False)
bcomment = serializers.IntegerField(label='評論量', required=False)
image = serializers.ImageField(label='圖檔', required=False)
注意：serializer不是隻能為資料庫模型類定義，也可以為非資料庫模型類的資料定義。serializer是獨立于資料庫之外的存在。
2. 字段與選項
常用字段類型：
| 字段 | 字段構造方式 |
|---|---|
| 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) |
| 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=<a_field_instance>, min_length=None, max_length=None) |
| DictField | DictField(child=<a_field_instance>) |
選項參數：
| 參數名稱 | 作用 |
|---|---|
| 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頁面時，顯示的字段幫助提示資訊 |
序列化的使用
1.基本使用
對一個圖書對象進行序列化
from booktest.models import BookInfo
from booktest.serializers import BookInfoSerializer
book = BookInfo.objects.get(id=2)
serializer = BookInfoSerializer(book)
serializer.data
# {'id': 2, 'btitle': '天龍八部', 'bpub_date': '1986-07-24', 'bread': 36, 'bcomment': 40, 'image': None}
對多個圖書對象進行序列化，注意需要加參數many=True
from booktest.models import BookInfo
from booktest.serializers import BookInfoSerializer
book_qs = BookInfo.objects.all()
serializer = BookInfoSerializer(book_qs, many=True)
serializer.data
# [OrderedDict([('id', 2), ('btitle', '天龍八部'), ('bpub_date', '1986-07-24'), ('bread', 36), ('bcomment', 40), ('image', N]), OrderedDict([('id', 3), ('btitle', '笑傲江湖'), ('bpub_date', '1995-12-24'), ('bread', 20), ('bcomment', 80), ('image'ne)]), OrderedDict([('id', 4), ('btitle', '雪山飛狐'), ('bpub_date', '1987-11-11'), ('bread', 58), ('bcomment', 24), ('ima None)]), OrderedDict([('id', 5), ('btitle', '西遊記'), ('bpub_date', '1988-01-01'), ('bread', 10), ('bcomment', 10), ('im', 'booktest/xiyouji.png')])]
2 關聯對象嵌套序列化（在有外鍵的時候使用）
1） PrimaryKeyRelatedField
此字段将被序列化為關聯對象的主鍵。
hbook = serializers.PrimaryKeyRelatedField(label='圖書', read_only=True)
2) StringRelatedField
此字段将被序列化為關聯對象的字元串表示方式（即__str__方法的傳回值）
hbook = serializers.StringRelatedField(label='圖書')
3）使用關聯對象的序列化器
hbook = BookInfoSerializer()
反序列化使用
使用序列化器進行反序列化時，需要對資料進行驗證後，才能擷取驗證成功的資料或儲存成模型類對象。
在擷取反序列化的資料前，必須調用is_valid()方法進行驗證，驗證成功傳回True，否則傳回False。
驗證失敗，可以通過序列化器對象的errors屬性擷取錯誤資訊，傳回字典，包含了字段和字段的錯誤。如果是非字段錯誤，可以通過修改REST framework配置中的NON_FIELD_ERRORS_KEY來控制錯誤字典中的鍵名。
驗證成功，可以通過序列化器對象的validated_data屬性擷取資料。
from booktest.serializers import BookInfoSerializer
data = {'bpub_date': 123}
serializer = BookInfoSerializer(data=data)
serializer.is_valid() # 傳回False
serializer.errors
# {'btitle': [ErrorDetail(string='This field is required.', code='required')], 'bpub_date': [ErrorDetail(string='Date has wrong format. Use one of these formats instead: YYYY[-MM[-DD]].', code='invalid')]}
serializer.validated_data # {}
data = {'btitle': 'python'}
serializer = BookInfoSerializer(data=data)
serializer.is_valid() # True
serializer.errors # {}
serializer.validated_data # OrderedDict([('btitle', 'python')])
is_valid()方法還可以在驗證失敗時抛出異常serializers.ValidationError，可以通過傳遞raise_exception=True參數開啟，REST framework接收到此異常，會向前端傳回HTTP 400 Bad Request響應。
# Return a 400 response if the data was invalid.
serializer.is_valid(raise_exception=True)
多思考也是一種努力，做出正确的分析和選擇，因為我們的時間和精力都有限，是以把時間花在更有價值的地方。
![django rest framework學習[圖]](data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=)