Django rest框架嵌套自引用对象

发布于11月14日

我有一个模型，看起来是这样的:

class Category(models.Model):
    parentCategory = models.ForeignKey('self', blank=True, null=True, related_name='subcategories')
    name = models.CharField(max_length=200)
    description = models.CharField(max_length=500)

我设法用serializer获得了所有类别的平面json表示:

class CategorySerializer(serializers.HyperlinkedModelSerializer):
    parentCategory = serializers.PrimaryKeyRelatedField()
    subcategories = serializers.ManyRelatedField()

    class Meta:
        model = Category
        fields = ('parentCategory', 'name', 'description', 'subcategories')

现在我要做的是使子类别列表具有子类别的内联json表示，而不是它们的ID.我如何使用Django -睡觉-框架做到这一点？我试着在文档中找到它，但它似乎不完整.

推荐答案

不使用ManyRelatedField，而是使用嵌套的序列化程序作为字段:

class SubCategorySerializer(serializers.ModelSerializer):
    class Meta:
        model = Category
        fields = ('name', 'description')

class CategorySerializer(serializers.ModelSerializer):
    parentCategory = serializers.PrimaryKeyRelatedField()
    subcategories = serializers.SubCategorySerializer()

    class Meta:
        model = Category
        fields = ('parentCategory', 'name', 'description', 'subcategories')

如果你想处理任意嵌套的字段，你应该看看文档的customising the default fields部分.当前不能直接将序列化程序声明为其自身的字段，但可以使用这些方法覆盖默认情况下使用的字段.

class CategorySerializer(serializers.ModelSerializer):
    parentCategory = serializers.PrimaryKeyRelatedField()

    class Meta:
        model = Category
        fields = ('parentCategory', 'name', 'description', 'subcategories')

        def get_related_field(self, model_field):
            # Handles initializing the `subcategories` field
            return CategorySerializer()

实际上，正如您已经注意到的那样，上面的说法并不完全正确. 这有点麻烦，但是您可以try 在已经声明了序列化程序之后添加该字段.

class CategorySerializer(serializers.ModelSerializer):
    parentCategory = serializers.PrimaryKeyRelatedField()

    class Meta:
        model = Category
        fields = ('parentCategory', 'name', 'description', 'subcategories')

CategorySerializer.base_fields['subcategories'] = CategorySerializer()

需要添加声明递归关系的机制.

Edit:请注意，现在有专门处理这类用例的第三方包可用.请参见djangorestframework-recursive.