如何在DRF ModelSerializer中为单例与列表设置不同depth值

要实现列表接口用depth=0、单个实例接口用depth=1，有两种常用的实现方式：

方法一：重写序列化器的__init__方法动态修改depth #

通过在序列化器初始化时，根据视图的action或者传入的实例类型，动态调整Meta.depth的值：

from rest_framework import serializers
from django.db.models import query

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ['id', 'first_name', 'last_name', 'organization']
        depth = 1  # 默认使用详情场景的depth

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        
        # 方式1：通过视图action判断（适用于ViewSet）
        view = self.context.get('view')
        if view and view.action == 'list':
            self.Meta.depth = 0
        
        # 方式2：如果没有视图上下文，判断实例是否为列表/查询集（通用场景）
        # if isinstance(self.instance, (list, query.QuerySet)):
        #     self.Meta.depth = 0

这种方法无需额外定义新的序列化器，适合字段结构完全一致，仅depth不同的场景。

方法二：定义两个序列化器，视图中按需切换 #

分别定义列表用和详情用的序列化器，在视图的get_serializer_class方法中根据action返回对应序列化器：

from rest_framework import serializers

# 列表场景序列化器：depth=0
class UserListSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ['id', 'first_name', 'last_name', 'organization']
        depth = 0

# 详情场景序列化器：depth=1
class UserDetailSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ['id', 'first_name', 'last_name', 'organization']
        depth = 1

在视图中指定序列化器：

from rest_framework import viewsets

class UserViewSet(viewsets.ModelViewSet):
    queryset = User.objects.all()

    def get_serializer_class(self):
        # 详情接口使用UserDetailSerializer，其他接口（列表、创建等）用UserListSerializer
        if self.action == 'retrieve':
            return UserDetailSerializer
        return UserListSerializer

这种方式更清晰，后续如果列表和详情需要差异化字段时，扩展起来更方便。

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