序列化器 ValidationError 的自定义格式

Question

我在我的序列化器之一中有一个自定义对象级验证器：

def validate(self, data):
    # some checks on token
    # set token to True or False
    
    if not token:
        raise serializers.ValidationError(
            {
                "status": "failed",
                "message": _("token is not valid"),
            }
        )
    
    return data

我期望得到的输出是这样的：

{
    "status": "failed",
    "message": "token is not valid"
}

但是，我实际得到的是：

{
    "status": [
        "failed"
    ],
    "message": [
        "token is not valid"
    ]
}

有没有办法实现我正在寻找的东西？

Answer 1

创建自定义 ValidatorError 类：

from rest_framework import serializers, status
from rest_framework.exceptions import APIException


class PlainValidationError(APIException):
    status_code = status.HTTP_400_BAD_REQUEST
    default_detail = _("Invalid input.")
    default_code = "invalid"

    def __init__(self, detail=None, code=None):
        if not isinstance(detail, dict):
            raise serializers.ValidationError("Invalid Input")
        self.detail = detail

不要使用 serializers.ValidationError，而是使用自定义 ValidationError 类：

def validate(self, data):
    # some checks on token
    # set token to True or False
    
    if not token:
        raise PlainValidationError(
            {
                "status": "failed",
                "message": _("token is not valid"),
            }
        )
    
    return data

它并不完美，但它适合我。

Answer 2

通过在视图端验证您的令牌，您可以更轻松地实现此目的。例如，您的视图将如下所示：

# Your view
class MyView(APIView):
    def post(self, request, *args, **kwargs):
        serializer = self.serializer_class(
            data=request.data, context={"request": request}
        )
        serializer.is_valid()
        token = serializer.validated_data["token"]
        if not token:
            return Response(
                data={"status": "failed", "message": _("token is not valid")},
                status=401
            )
        # The rest of your code below

您可以设置该行
如果您还有其他验证要做，请将 serializer.is_valid() 更改为 serializer.is_valid(raise_exception=True)。
我希望这会有所帮助