Django Rest Framework RetrieveAPIView自定义返回响应问题求助

错误原因分析 #

你遇到的「Object of Type is not JSON serializable」错误，核心问题有两个：

1. 直接将QuerySet/模型实例传入Response，DRF无法直接将数据库查询对象序列化为JSON格式。
2. 视图中serializer_class配置错误，指向了视图类GetClientDetails而非对应的序列化器类。

修正方案 #

1. 定义正确的序列化器

在serializers.py中创建对应模型的序列化器，指定需要返回的字段：

from rest_framework import serializers
from .models import TablePVUser

class GetClientDetailsSerializer(serializers.ModelSerializer):
    class Meta:
        model = TablePVUser
        fields = '__all__'  # 或按需指定字段，如['pv_owner', 'user', 'xxx']

2. 修改视图代码

调整视图中的序列化器配置，并用序列化器处理查询结果后返回自定义格式响应：

# views.py
from rest_framework import generics, status
from rest_framework.response import Response
from .models import TablePVUser
from .serializers import GetClientDetailsSerializer

class GetClientDetails(generics.RetrieveAPIView):
    queryset = TablePVUser.objects.all()
    serializer_class = GetClientDetailsSerializer  # 替换为正确的序列化器类
    lookup_field = 'pv_owner'

    def get(self, request, pv_owner):
        try:
            # RetrieveAPIView用于单个对象查询，用get()获取实例
            instance = self.get_queryset().get(pv_owner=pv_owner, user__is_active=True)
            serializer = self.get_serializer(instance)
            
            # 返回自定义格式响应
            return Response({
                'msg': 'success',
                'data': serializer.data
            }, status=status.HTTP_200_OK)
        except TablePVUser.DoesNotExist:
            # 处理对象不存在的异常
            return Response({
                'msg': '用户不存在或已禁用',
                'data': None
            }, status=status.HTTP_404_NOT_FOUND)

3. 多对象查询场景适配

如果你的需求是根据pv_owner返回多个活跃用户，建议改用ListAPIView更贴合DRF设计：

class GetClientDetails(generics.ListAPIView):
    serializer_class = GetClientDetailsSerializer
    lookup_field = 'pv_owner'

    def get_queryset(self):
        pv_owner = self.kwargs.get('pv_owner')
        return TablePVUser.objects.filter(pv_owner=pv_owner, user__is_active=True)

    def list(self, request, *args, **kwargs):
        queryset = self.get_queryset()
        serializer = self.get_serializer(queryset, many=True)
        return Response({
            'msg': 'success',
            'data': serializer.data
        }, status=status.HTTP_200_OK)

关键要点 #

• 序列化器是核心：必须通过序列化器将模型实例/QuerySet转换为JSON可识别的字典结构，不能直接传递数据库查询对象。
• 视图类匹配场景：RetrieveAPIView适用于单个对象查询，ListAPIView适用于多个对象列表查询，按需选择更规范。
• 异常处理：添加异常捕获逻辑，提升接口的健壮性和友好性。

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