Як включити відповідні поля моделей за допомогою програми Django Rest Framework?

Скажімо, у нас є така модель:

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
        }, 
    ]
},

Чи можливо це? Якщо так, то як? І це погана ідея?

Найпростіший спосіб - використовувати аргумент глибини

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аргумент, замість цього переконавшись, що teachersатрибут існує, використовуючи параметр related_name у вашій Teacherмоделі, тобто.classroom = models.ForeignKey(Classroom, related_name='teachers')

Слід пам’ятати, що вкладені серіалізатори на даний момент не підтримують операції запису. Для представлених даних, що записуються, слід використовувати регулярні плоскі подання, такі як pk або гіперпосилання.

Дякую @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",)

Це також можна досягти, використовуючи досить зручний джинсовий джанго, упакований під назвою drf-flex-polja . Ми використовуємо це, і це досить приголомшливо. Ви просто встановите його 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-адреси, і вона повертає розширену відповідь. Сподіваюся, це допоможе комусь, коли-небудь. Ура!