Como incluir campos de modelo relacionados usando o Django Rest Framework?

Digamos que temos o seguinte modelo:

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

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

Digamos que, em vez de obter um resultado como este pela função ManyRelatedPrimaryKeyField:

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

retorne algo que inclua a representação completa do modelo relacionado, como:

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

Isso é possível? Se sim, como? E isso é uma má ideia?

A maneira mais simples é usar o argumento de profundidade

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

No entanto, isso incluirá apenas relacionamentos para relacionamentos futuros, o que, nesse caso, não é exatamente o que você precisa, pois o campo de professores é um relacionamento inverso.

Se você possui requisitos mais complexos (por exemplo, inclua relacionamentos reversos, aninhe alguns campos, mas não outros, ou aninhe apenas um subconjunto específico de campos), poderá aninhar serializadores , por exemplo ...

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

Observe que usamos o argumento de origem no campo serializador para especificar o atributo a ser usado como a origem do campo. Poderíamos descartar o sourceargumento, garantindo que o teachersatributo exista usando a opção related_name no seu Teachermodelo, ou seja.classroom = models.ForeignKey(Classroom, related_name='teachers')

Uma coisa a ter em mente é que os serializadores aninhados atualmente não suportam operações de gravação. Para representações graváveis, você deve usar representações planas regulares, como pk ou hiperlink.

Obrigado @TomChristie !!! Você me ajudou muito! Gostaria de atualizar um pouco (por causa de um erro que encontrei)

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",)

Isso também pode ser feito usando um django dandy bastante útil chamado drf-flex-fields . Nós o usamos e é incrível. Você acabou de instalar pip install drf-flex-fields, passar pelo serializador, adicionar expandable_fieldse bingo (exemplo abaixo). Ele também permite que você especifique relacionamentos aninhados profundos usando a notação de ponto.

from rest_flex_fields import FlexFieldsModelSerializer

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

Então você adiciona ?expand=teacher_setao seu URL e ele retorna uma resposta expandida. Espero que isso ajude alguém, algum dia. Felicidades!