DRF Spectacular中如何让子类ViewSet使用专属响应序列化器？

针对你遇到的父类@extend_schema装饰器无法动态引用子类专属序列化器的问题，以下是几种可行的实现方案：

方案一：类属性+动态序列化器引用 #

通过在父类定义响应序列化器的类属性，子类仅需覆盖该属性即可，结合DRF Spectacular支持的可调用响应参数实现动态获取：

父类ViewSet代码 #

from drf_spectacular.utils import extend_schema, OpenApiParameter, OpenApiResponse, OpenApiTypes
from rest_framework import viewsets

class BaseCRUDViewSet(viewsets.GenericViewSet):
    # 定义父类默认的响应序列化器
    retrieve_response_serializer = GenericResponseSerializer

    @extend_schema(
        parameters=[
            OpenApiParameter(name="jwt_token", description="JSON Web Token", required=True, type=str),
            OpenApiParameter(name="id", type=OpenApiTypes.STR, location=OpenApiParameter.PATH, description="ID"),
        ],
        methods=["GET"],
        description='Return a serialized object',
        request=JWTRequestSerializer,
        responses={
            200: OpenApiResponse(
                # 通过lambda动态获取当前视图实例的序列化器类
                response=lambda view: view.retrieve_response_serializer,
                description="Success response"
            )
        },
    )
    def retrieve(self, request, pk=None):
        # 父类CRUD逻辑实现
        instance = self.get_object()
        serializer = self.get_serializer(instance)
        return Response(serializer.data)

子类ViewSet代码 #

子类仅需覆盖retrieve_response_serializer属性，无需修改或重新装饰retrieve方法：

class UserViewSet(BaseCRUDViewSet):
    retrieve_response_serializer = UserResponseSerializer
    # 其他子类专属配置，比如queryset、serializer_class等

class ProductViewSet(BaseCRUDViewSet):
    retrieve_response_serializer = ProductResponseSerializer

方案二：使用extend_schema_view批量覆盖schema #

利用DRF Spectacular提供的extend_schema_view，在子类中仅覆盖retrieve方法的响应配置，复用父类的其他schema参数：

子类ViewSet代码 #

from drf_spectacular.utils import extend_schema_view, extend_schema

class UserViewSet(BaseCRUDViewSet):
    pass

# 用extend_schema_view覆盖retrieve方法的responses配置
extend_schema_view(
    retrieve=extend_schema(responses={200: UserResponseSerializer})
)(UserViewSet)

或者更简洁的类内写法：

class ProductViewSet(BaseCRUDViewSet):
    @extend_schema_view(
        retrieve=extend_schema(responses={200: ProductResponseSerializer})
    )
    class Meta:
        pass

方案三：自定义序列化器获取方法 #

如果需要更复杂的动态逻辑（比如根据请求参数选择序列化器），可以在父类定义序列化器获取方法，子类覆写该方法后在schema中动态调用：

父类ViewSet代码 #

class BaseCRUDViewSet(viewsets.GenericViewSet):
    def get_retrieve_response_serializer(self):
        # 父类默认实现
        return GenericResponseSerializer

    @extend_schema(
        # 其他参数同前
        responses={
            200: OpenApiResponse(
                response=lambda view: view.get_retrieve_response_serializer(),
                description="Success response"
            )
        },
    )
    def retrieve(self, request, pk=None):
        # 父类逻辑
        pass

子类ViewSet代码 #

class UserViewSet(BaseCRUDViewSet):
    def get_retrieve_response_serializer(self):
        # 根据请求动态返回序列化器示例
        if self.request.query_params.get('detail'):
            return UserDetailResponseSerializer
        return UserResponseSerializer

注意事项 #

• 不要传入序列化器实例（比如GenericResponseSerializer()），DRF Spectacular需要的是序列化器类，否则会无法正确生成Schema。
• 所有方案都是利用DRF Spectacular对可调用响应参数的支持，在Schema生成阶段动态获取子类的专属配置，避免了装饰器在类定义阶段静态绑定父类方法的问题。

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