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

Question

例如，如果您采用模型：

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，但我这样做是为了让它更清楚。

在此示例中，有时您只想返回一个 Region 列表。其他时候，您希望返回区域列表，其中包含每个区域下每个区域的公司列表。

我想，您还需要更多详细信息，其中包含区域列表、它们的公司子级以及每个公司的员工子级。

就其余框架视图而言，处理这些不同级别的深度/细节的最佳方法是什么。人们通常如何处理这种情况？

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

Answer 1

简单地返回列表区域

--> 在调用它时使用带有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以获取更多参考。

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