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

これは可能ですか？もしそうなら、どうですか？そして、これは悪い考えですか？

最も簡単な方法は、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代わりに、モデルでrelated_nameオプションteachersを使用して属性が存在することを確認することで、引数を削除できます。Teacherclassroom = models.ForeignKey(Classroom, related_name='teachers')

留意すべきことの1つは、ネストされたシリアライザーは現在書き込み操作をサポートしていないことです。書き込み可能な表現の場合、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-fieldsと呼ばれる非常に便利なdandy djangoパッケージを使用して行うこともできます。私たちはそれを使用しており、それはかなり素晴らしいです。あなたはそれをインストールし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に追加すると、拡張された応答が返されます。これがいつか誰かを助けることを願っています。乾杯！