现在我们的API中的关系通过使用主键来表示。在本教程的这一部分中，我们将通过使用超链接来改善关系的内聚性和可发现性。
使用source属性
model型类
models.py
# 文章
class Article(ModelBase):
# null是在数据库上表现NULL，而不是一个空字符串，所以对空字符串的限制，还需要通过blank，是否能为空字符串控制
title = models.CharField(max_length=35, validators=[MinLengthValidator(1), ], unique=True, verbose_name='标题')
keywords = models.CharField(max_length=50, validators=[MinLengthValidator(1), ], verbose_name='关键词')
description = models.CharField(verbose_name='描述', max_length=120, validators=[MinLengthValidator(1), ], blank=True) #选填，如果不填默认抓取正文前54个字
content = models.TextField(verbose_name='内容')
cover_img = models.URLField(verbose_name='封面图', blank=True)
#PositiveIntegerField，该类型的值只允许为正整数或 0，毕竟阅读量不可能为负值。
read_num = models.PositiveIntegerField(verbose_name='浏览量', default=0)
like_num = models.IntegerField(verbose_name='点赞数', default=0)
category = models.ForeignKey(Category, on_delete=models.DO_NOTHING, verbose_name='所属类别') #多对一关系
tag = models.ManyToManyField(Tag) #多对多关系
#当外键指向的数据对象被删除“on_delete”时，models.DOTHING，即用户删除时，文章不做任何处理
author = models.ForeignKey(Account, on_delete=models.DO_NOTHING, related_name='articles', verbose_name='作者')
class Meta:
db_table = 'tb_article'
ordering = ['-create_time']
verbose_name = u'文章'
verbose_name_plural = verbose_name
def __str__(self):
return self.title
序列化
serializers.py
class ArticleSerializer(serializers.Serializer): # 与django的表单类相似
id = serializers.IntegerField()
title = serializers.CharField(label='标题', max_length=35, required=True, error_messages={'required': '标题不能为空', 'max_length': '标题不能超过35个字符'})
keywords = serializers.CharField(label='关键字', max_length=50, required=False)
description = serializers.CharField(label='描述', max_length=120, allow_blank=True, required=False)
# content = serializers.CharField()
cover_img = serializers.URLField(label='封面图', allow_blank=True)
read_num = serializers.IntegerField(label='浏览量', default=0)
like_num = serializers.IntegerField(label='点赞数', default=0)
# 分类名称
category = serializers.CharField(source='category.name', label='所属类别') #多对一关系
author = serializers.CharField(source='author.nick_name', label='作者')
# SerializerMethodField(),表示自定义显示 然后写一个自定义的方法get_字段名
tag = serializers.SerializerMethodField() #多对多关系
def get_tag(self, obj): # 注意这里get_对应上面字段
tags = obj.tag.all()
tag_list = []
for tag in tags:
tag_list.append({'pk':tag.pk, 'name': tag.name}) # 列表里面需要序列化形式
return tag_list
url配置
urls.py
urlpatterns = [
path('articles/', ArticListleView.as_view(), name='article_list' ),
path('articles/<int:pk>/', ArticleDetailView.as_view(), name='article_detail'),
]
视图
views.py
class ArticListleView(generics.ListCreateAPIView):
queryset = Article.objects.all() # 查询结果集
serializer_class = ArticleSerializer # 序列化类
class ArticleDetailView(generics.RetrieveUpdateDestroyAPIView):
queryset = Article.objects.all() # 查询结果集
serializer_class = ArticleSerializer # 序列化类
测试效果
image.png
通过以上实例，可以看到将外键相关字段查询出来了，通过source字段
注意：sourse参数用于控制属性被用来填充字段，并且可以指向序列化实例上的任何属性。它也可以采用上面所示 的点标记.，这种情况下它将遍历给定的属性，与使用Django的模板语言类似的方式。对于多对多关系的tag使用SerializerMethodField()，表示自定义显示 然后写一个自定义的方法get_字段名实现获取对象对应字段
使用PrimaryKeyRelatedField
使用 PrimaryKeyRelatedField 将返回一个对应关系 model 的主键。
cateogry = serializers.PrimaryKeyRelatedField(queryset=Category.objects.all())
author = serializers.PrimaryKeyRelatedField(queryset=Account.objects.all()) # 一方不需要用many
# 不过这样只是用户获得的只是一个外键类别的id，并不能获取到详细的信息，如果想要获取到具体信息，那需要嵌套serializer
#author = AccountSerializer() # author一定要是article model中存在的字段
tag = serializers.PrimaryKeyRelatedField(many=True, queryset=Tag.objects.all()) # 多对多用many=True
使用PrimaryKeyRelatedField只是获取外键类别的id，并不能获取到详细的信息，如果要获取到具体信息，那就需要嵌套serializer
嵌套serializer
from rest_framework import serializers
from article.models import Article, Category, Tag, Column
from user.models import Account
class ColumnSerializer(serializers.ModelSerializer):
class Meta:
model = Column
fields = '__all__'
class CategorySerializer(serializers.ModelSerializer):
column = ColumnSerializer()
class Meta:
model = Category
fields = ['id','name', 'column']
class ArticleSerializer(serializers.Serializer): # 与django的表单类相似
id = serializers.IntegerField()
title = serializers.CharField(label='标题', max_length=35, required=True, error_messages={'required': '标题不能为空', 'max_length': '标题不能超过35个字符'})
keywords = serializers.CharField(label='关键字', max_length=50, required=False)
description = serializers.CharField(label='描述', max_length=120, allow_blank=True, required=False)
# content = serializers.CharField()
cover_img = serializers.URLField(label='封面图', allow_blank=True)
read_num = serializers.IntegerField(label='浏览量', default=0)
like_num = serializers.IntegerField(label='点赞数', default=0)
# 分类名称
#category = serializers.CharField(source='category.name', label='所属类别') #多对一关系
#author = serializers.CharField(source='author.nick_name', label='作者')
# SerializerMethodField(),表示自定义显示 然后写一个自定义的方法get_字段名
#tag = serializers.SerializerMethodField() #多对多关系
category = CategorySerializer()
author = serializers.PrimaryKeyRelatedField(queryset=Account.objects.all()) # 一方不需要用many
# 不过这样只是用户获得的只是一个外键类别的id，并不能获取到详细的信息，如果想要获取到具体信息，那需要嵌套serializer
#author = AccountSerializer() # author一定要是article model中存在的字段
tag = serializers.PrimaryKeyRelatedField(many=True, queryset=Tag.objects.all()) # 多对多用many=True
测试效果
image.png
通过测试可以看出通过嵌套serializers我们输出了外键关联的所有信息，否则只是获取外键类别的id。
使用depth
如果用ModelSerializer来序列化模型类的话，我们可以用depth来返回外键对象的详细信息，修改序列为为:
class ArticleSerializer(serializers.ModelSerializer):
class Meta:
model = Article
fields = ['id', 'title', 'keywords', 'description', 'cover_img', 'read_num', 'like_num', 'category', 'tag', 'author']
depth = 1
测试结果
image.png
从上面可以看到在ModelSerializer通过depth自动序列化连表。其中depth表示连表深度，比如category对应的外键为column。
如果不写depth和depth为0，不会则不会显示column信息
image.png
如果为depth=1
image.png
如果为depth=2
image.png
官方建议最多不超过10层。
使用HyperlinkedIdentityField
我们也可以在实体之间用超链接表示。
修改我们之前的
序列化
class CategorySerializer(serializers.ModelSerializer):
column = ColumnSerializer()
class Meta:
model = Category
fields = ['id','name', 'column']
class ArticleSerializer(serializers.ModelSerializer):
# view_name表示路由的别名,注意如果不是根目录下，则需要使用命名空间来：，
# lookup_field:根据表指定字段，来拼路径，生成链接
# lookup_url_kwarg：默认是pk，（urls.py中的指定的pk）可以不写，反向解析有名分组的名字。
category = serializers.HyperlinkedIdentityField(view_name='api:category_detail', lookup_field='category_id', lookup_url_kwarg='pk')
class Meta:
model = Article
fields = ['id', 'title', 'keywords', 'description', 'cover_img', 'read_num', 'like_num', 'category', 'tag', 'author']
url配置
urlpatterns = [
path('articles/', ArticListleView.as_view(), name='article_list' ),
path('articles/<int:pk>/', ArticleDetailView.as_view(), name='article_detail'),
path('categories/<int:pkx>/', CategoryDetailView.as_view(), name='category_detail'),
]
注意：url中name和pkx与序列化中的对应关系
视图
class CategoryDetailView(generics.RetrieveUpdateDestroyAPIView):
queryset = Category.objects.all() # 查询结果集
serializer_class = CategorySerializer # 序列化类
class ArticListleView(generics.ListCreateAPIView):
queryset = Article.objects.all() # 查询结果集
serializer_class = ArticleSerializer # 序列化类
反向查询
比如我一个栏目column下有多个种类category，我要查栏目下有那些种类，则用到到反向查询
class ColumnSerializer(serializers.ModelSerializer):
categories = serializers.StringRelatedField(many=True) # 字段名必须设置related_name 或者使用表名_set 就行了
class Meta:
model = Column
fields = ['id','name', 'link_url', 'index','categories']
class CategorySerializer(serializers.ModelSerializer):
column = ColumnSerializer()
class Meta:
model = Category
fields = ['id','name', 'column']
注意
反向查询序列字段中需要用related_name或者子表小写表名_set
测试效果：
image.png
实体之间关系
多对一：ForeignKey
多对多: ManyToManyField
一对一：OneToOneField
处理好实体之间的关系是Web API设计中极具挑战性的方面之一。我们可以选择以下来表示关系：
1.使用主键;
2.在实体之间使用超链接;
3.在相关的实体上使用独一无二的slug field;
4.使用相关实体的默认字符串;
5.在父表述使用嵌套的实体;
6.其他自定义的表述。
1、api参考
tracks = serializers.StringRelatedField(many=True) # 字符串形式关系字段
tracks = serializers.PrimaryKeyRelatedField(many=True, read_only=True)# 主键形式关系字段
tracks = serializers.HyperlinkedRelatedField(many=True, read_only=True, view_name=’track-detail’) # 超链接形式关系字段
tracks = serializers.SlugRelatedField(many=True, read_only=True, slug_field=’title’) # 以小标题形式关系
track_listing = serializers.HyperlinkedIdentityField(view_name=’track-list’) # 超链接身份关系
2、嵌套关系
序列化类中可以直接引用其他序列化化类。
通过以上正反向都可以。
