Wagtail项目自定义关联模型Serializer Field报TypeError如何解决？

解决方案 #

你遇到的报错本质是DRF默认无法直接将Django模型实例转为JSON可序列化结构，手动拼接字典的方案仅适用于简单一对一关联，无法适配多类关联场景。你可以直接复用DRF原生的嵌套序列化器能力实现通用方案，无需手写遍历逻辑：

步骤1：定义关联模型独立序列化器

针对Game、Wagtail图片等类型分别定义可复用的序列化器，多对多/一对多字段只需添加many=True参数即可自动适配：

from rest_framework import serializers
from wagtail.images.api.fields import ImageRenditionField
from .models import Game, GameBlogPage

# Game模型序列化器，可复用在所有需要返回Game数据的场景
class GameSerializer(serializers.ModelSerializer):
    class Meta:
        model = Game
        fields = ['id', 'title']

步骤2：定义GameBlogPage嵌套序列化器

直接在字段上指定对应关联模型的序列化器，支持任意关联类型：

class GameBlogPageSerializer(serializers.ModelSerializer):
    # 外键关联直接指定对应序列化器即可
    game = GameSerializer(read_only=True)
    # Wagtail图片类型直接使用官方提供的序列化字段，自动处理url、宽高等属性
    album_image = ImageRenditionField('original', read_only=True)
    # 多对多关联只需加many=True参数，DRF自动转为数组结构
    # blog_authors = AuthorSerializer(many=True, read_only=True)
    
    class Meta:
        model = GameBlogPage
        fields = ['id', 'title', 'introduction', 'game', 'published_date', 'album_image']

步骤3：直接在Wagtail APIField中引用序列化器

无需自定义GameBlogPageField类，直接将嵌套序列化器传入APIField的serializer参数即可，查询集会被自动序列化：

class GameIndexPage(Page):
    # 原有逻辑保持不变
    ...
    api_fields = [
        APIField('introduction'),
        APIField('image'),
        # 传入many=True适配查询集场景
        APIField('children', serializer=GameBlogPageSerializer(many=True, read_only=True))
    ]

自定义Field兼容方案

如果有特殊逻辑必须自定义Field类，可直接在to_representation方法中调用上述序列化器，无需手动拼接字段：

class GameBlogPageField(serializers.Field):
    def to_representation(self, queryset):
        # 传入context保证序列化器能访问请求等上下文信息
        serializer = GameBlogPageSerializer(queryset, many=True, context=self.context)
        return serializer.data

内容的提问来源于stack exchange，提问作者Christian Aranas