Django 3.2 API中LinkPreview对象无法JSON序列化问题求助

错误原因 #

你遇到的TypeError: Object of type LinkPreview is not JSON serializable，是因为Django REST Framework的Response会自动将返回内容序列化为JSON格式，但LinkPreview是第三方包的自定义类实例，Python默认没有对应的序列化逻辑，无法直接将其转换为JSON可识别的类型（如字典、列表等）。

解决方案 #

方法1：利用LinkPreview自带的转字典方法 #

linkpreview包的LinkPreview类提供了to_dict()方法，可直接将对象转换为包含预览数据的字典，让Django能正常序列化。

修改PreviewLink视图代码：

class PreviewLink(APIView):
    permission_classes = (IsAuthenticated, IsNotSuspended)
    throttle_scope = 'link_preview'

    def post(self, request):
        serializer = PreviewLinkSerializer(data=request.data, context={"request": request})
        serializer.is_valid(raise_exception=True)
        data = serializer.validated_data

        link = data.get('link')
        user = request.user

        link_preview = user.preview_link(link)
        # 将LinkPreview对象转为字典
        preview_data = link_preview.to_dict()

        return Response(preview_data, status=status.HTTP_200_OK)

同时修复LinkIsPreviewable视图的逻辑错误：原代码直接将LinkPreview对象赋值给is_previewable，同样会触发序列化问题，正确逻辑是只要生成预览无异常就返回True：

class LinkIsPreviewable(APIView):
    permission_classes = (IsAuthenticated, IsNotSuspended)
    throttle_scope = 'link_preview'

    def post(self, request):
        serializer = PreviewLinkSerializer(data=request.data, context={"request": request})
        serializer.is_valid(raise_exception=True)
        data = serializer.validated_data

        link = data.get('link')

        try:
            # 尝试生成预览，无异常则标记为可预览
            link_preview(url=link)
            is_previewable = True
        except Exception as e:
            is_previewable = False

        return Response({
            'is_previewable': is_previewable
        }, status=status.HTTP_200_OK)

方法2：自定义Django序列化器（推荐用于字段控制） #

如果需要精确控制返回的预览字段，可以自定义序列化器来处理LinkPreview对象：

# 在serializers.py中添加
from rest_framework import serializers

class LinkPreviewDataSerializer(serializers.Serializer):
    title = serializers.CharField()
    description = serializers.CharField(allow_blank=True)
    image = serializers.URLField(allow_null=True)
    url = serializers.URLField()
    site_name = serializers.CharField(allow_blank=True)

然后在PreviewLink视图中使用该序列化器：

class PreviewLink(APIView):
    permission_classes = (IsAuthenticated, IsNotSuspended)
    throttle_scope = 'link_preview'

    def post(self, request):
        serializer = PreviewLinkSerializer(data=request.data, context={"request": request})
        serializer.is_valid(raise_exception=True)
        data = serializer.validated_data

        link = data.get('link')
        user = request.user

        link_preview = user.preview_link(link)
        # 使用自定义序列化器处理LinkPreview对象
        data_serializer = LinkPreviewDataSerializer(link_preview)

        return Response(data_serializer.data, status=status.HTTP_200_OK)

这种方式可以过滤掉不必要的字段，让API返回的数据更简洁。

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