如何使用Django Rest Framework包含相关的模型字段？

Question

假设我们有以下模型:

class Classroom(models.Model):
    room_number = [....]

class Teacher(models.Model):
    name = [...]
    tenure = [...]
    classroom = models.ForeignKey(Classroom)

假设不是按照ManyRelatedPrimaryKeyField函数得到这样的结果:

{
    "room_number": "42", 
    "teachers": [
        27, 
        24, 
        7
    ]
},

让它返回包含完整相关模型表示的东西,如:

{
    "room_number": "42", 
    "teachers": [
        {
           'id':'27,
           'name':'John',
           'tenure':True
        }, 
        {
           'id':'24,
           'name':'Sally',
           'tenure':False
        }, 
    ]
},

这可能吗？如果是这样,怎么样？这是个坏主意吗？

Answer 1

最简单的方法是使用depth参数

class ClassroomSerializer(serializers.ModelSerializer):
    class Meta:
        model = Classroom
        depth = 1

但是,这只包括前向关系的关系,在这种情况下,这种关系并不是你所需要的,因为教师领域是一种反向关系.

如果您有更复杂的要求(例如,包括反向关系,嵌套某些字段,而不是其他字段,或只嵌套字段的特定子集),您可以嵌套序列化程序,例如......

class TeacherSerializer(serializers.ModelSerializer):
    class Meta:
        model = Teacher
        fields = ('id', 'name', 'tenure')

class ClassroomSerializer(serializers.ModelSerializer):
    teachers = TeacherSerializer(source='teacher_set')

    class Meta:
        model = Classroom

请注意,我们使用序列化程序字段上的source参数指定要用作字段源的属性.我们可以source通过在模型上teachers使用related_name选项确保属性存在来删除参数Teacher,即.classroom = models.ForeignKey(Classroom, related_name='teachers')

要记住的一件事是嵌套序列化程序当前不支持写操作.对于可写表示,您应该使用常规的平面表示,例如pk或超链接.

Answer 2

谢谢@TomChristie !!! 你帮了我很多忙!我想稍微更新一下(因为我遇到了一个错误)

class TeacherSerializer(serializers.ModelSerializer):
    class Meta:
        model = Teacher
        fields = ('id', 'name', 'tenure')

class ClassroomSerializer(serializers.ModelSerializer):
    teachers = TeacherSerializer(source='teacher_set', many=True)

    class Meta:
        model = Classroom
        field = ("teachers",)

Answer 3

这也可以通过使用一个非常方便的dandy django 打包来完成，称为drf-flex-fields。我们使用它，它非常棒。您只需安装它pip install drf-flex-fields，通过您的序列化程序，添加expandable_fields和宾果游戏（下面的示例）。它还允许您使用点表示法指定深层嵌套关系。

from rest_flex_fields import FlexFieldsModelSerializer

class ClassroomSerializer(FlexFieldsModelSerializer):
    class Meta:
        model = Model
        fields = ("teacher_set",)
        expandable_fields = {"teacher_set": (TeacherSerializer, {"source": "teacher_set"})}

然后您添加?expand=teacher_set到您的 URL 并返回扩展响应。希望这有助于某人，有一天。干杯!