在前面的文章中我们以博客为例,自定义了一个简单的 ArticleSerializer
类, 并分别以函数视图(FBV)和基于类的视图(CBV)编写了博客文章列表资源和单篇文章资源的API,支持客户端以各种请求方式对文章资源进行增删查改。在本文中,我们将玩转DRF的序列化器,教你如何修改序列化器控制序列化后响应数据的输出格式, 如何在反序列化时对客户端提供过来的数据进行验证(validation)以及如何重写序列化器类自带的的create和update方法。
如果你还没阅读过前面的文章,推荐先阅读。即使你不阅读之前文章,你也会从本文中获得一些启发。
准备工作
我们的Article模型和自定义的序列化器ArticleSerializer类分别如下所示。
# blog/models.py
class Article(models.Model):
"""Article Model"""
STATUS_CHOICES = (
('p', 'Published'),
('d', 'Draft'),
)
title = models.CharField(verbose_name='Title (*)', max_length=90, db_index=True)
body = models.TextField(verbose_name='Body', blank=True)
author = models.ForeignKey(User, verbose_name='Author', on_delete=models.CASCADE, related_name='articles')
status = models.CharField(verbose_name='Status (*)', max_length=1, choices=STATUS_CHOICES, default='s', null=True, blank=True)
create_date = models.DateTimeField(verbose_name='Create Date', auto_now_add=True)
def __str__(self):
return self.title
# blog/serializers.py
class ArticleSerializer(serializers.ModelSerializer):
class Meta:
model = Article
fields = '__all__'
read_only_fields = ('id', 'author', 'create_date')
我们自定义的序列化器ArticleSerializer类包括了Article模型的所有字段,但由于我们不希望用户自行修改id, author和create_date三个字段,我们把它们设成了仅可读read_only_fields。如果你的其它代码正确,当你发送GET请求到/v1/articles, 我们可以看HTTP=200 OK的字样和如下json格式的文章列表数据。
[GET] http://127.0.0.1:8000/v1/articles
在这里你可以看到序列化后输出的json格式数据里author字段输出的是用户id,而不是用户名,