在Django REST Framework中处理不同级别的嵌套

2019年8月6日 177次阅读

例如,如果您采用模型：

class Region(models.Model):
    id = models.AutoField(primary_key=True)
    name = models.CharField(max_length=256)

class Company(models.Model):
    id = models.AutoField(primary_key=True)
    name = models.CharField(max_length=256)
    region = models.ForeignKey('Region', db_index=True)

class Staff(models.Model):
    id = models.AutoField(primary_key=True)
    name = models.CharField(max_length=256)
    company = models.ForeignKey('Company', db_index=True)

我知道我不需要在这些模型中包含id,但我这样做是为了让它更清晰.

在此示例中,有时您只想返回区域列表.其他时候,您希望返回一个区域列表,其中列出了每个区域下每个区域的公司.

我想,你也想要更详细的地方,你有一份地区名单,他们的公司子女和每个公司的员工子女.

就其他框架视图而言,处理这些不同级别的深度/细节的最佳方法是什么.人们通常如何处理这个问题？

我的意思是,当你说三个视图在顶层返回相同的东西时,你会使用什么样的命名约定,唯一的区别是它们包含多少层嵌套？

最佳答案 简单地返回列表区域

– >在调用时使用带有many = True的简单序列化程序(这将返回字典列表)

class SimpleRegionSerializer(serializers.ModelSerializer):
    class Meta:
        model = Region
        fields = ('id', 'name')

获取每个地区下每个地区公司列表的地区列表

– >使用嵌套的序列化程序

 class CompanySerializer(serializers.ModelSerializer):
     class Meta:
         model = Company
         fields = ('id', 'name')

 class NestedRegionSerializer(serializers.ModelSerializer):
     company = CompanySerializer(many=True, read_only=True)

     class Meta:
         model = Region
         fields = ('id', 'name')

同时将公司模型更改为

 class Company(models.Model):
     id = models.AutoField(primary_key=True)
     name = models.CharField(max_length=256)
     region = models.ForeignKey('Region', db_index=True, related_name='company')

related_name与NestedRegionSerializer中的序列化程序字段相同.

不要忘记运行迁移或syncdb

有关更多信息,请参阅http://www.django-rest-framework.org/api-guide/relations/#nested-relationships以获取更多参考.

您可以使用任何级别的嵌套,如果需要,您还可以指定“深度”作为元选项,它将提供有关嵌套深度的信息.

点赞