如何在 Django REST 中引发错误/返回 {"foo":["This field is required."]} 响应

Question

假设我有一个视图，我需要在调用 serializer.save 之前检查是否提供了一个字段，以确保我没有收到字典键错误：

class BarView(CreateAPIView):
    serializer_class = BarSerializer
    queryset = Bar.objects.all()
    def perform_create(self, serializer):
        if 'foo' not in self.request.data:
            raise ParseError('foo field required.')
        foo = get_object_or_404(Foo, pk=self.request.data['foo'])
        if foo.counter == 10:
            raise ParseError('foo limit reached.')
        return serializer.save(user=self.request.user, foo=foo)

我不想返回"foo field required."，而是想返回一条与 Django REST 返回的消息相同的消息，例如{"foo":["This field is required."]}

有没有更好的方法来做到这一点？或许用序列化器单独验证 foo 字段？

更新：我忘了说用户字段也是必需的。

Bar 的模型是：

class Bar(models.Model):
    user = models.ForeignKey(User, db_index=True, editable=False)
    foo = models.ForeignKey(Foo, db_index=True)

Answer 1

是的，

只需查看文档：Validation

（我假设字段foo 是Bar 模型的一部分，如果不是，请将其添加到Meta 中的fields）：

向 BarSerializer 添加验证：

class BarSerializer(serializers.ModelSerializer):
    def validate_foo(self, value):
        if not value:
            raise serializers.ValidationError("foo field required.")
        if Foo.objects.filter(pk=value, counter__gte=10).exists():
            raise serializers.ValidationError("foo limit reached.")
        return value

    class Meta:
        model = Bar

然后通过扩展来创建你的视图：

from rest_framework.exceptions import ValidationError

class MyCreateAPIView(CreateAPIView):        
    def post(self, request, *args, **kwargs):
        try:
             return super(BarView, self).post(request, *args, **kwargs)
        except ValidationError as e:
             return Response(e.detail, , status=status.HTTP_400_BAD_REQUEST)

    def create(self,request, *args, **kwargs):
        serializer = self.get_serializer(data=request.data)
        serializer.is_valid(raise_exception=True)
        try:
            self.perform_create(serializer)       
        except DjangoValidationError as e:
            raise ValidationError(e.messages)
        self.perform_create(serializer)
        headers = self.get_success_headers(serializer.data)
        return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)

    def perform_create(serializer):
        # do your stuff
        serializer.save()

Answer 2

是的，最好的方法是使用Meta 类中的extra_kwargs 选项在序列化程序中设置foo 字段。

DRF 将自动为您处理验证。您无需自己提出此验证错误。

class Meta:
    ...
    extra_kwargs = {'foo': {'required':True}} # make 'foo' a required field.

现在，每当request 中没有传递foo 字段时，serializer.errors 字典中就会有一个键foo，其值将是This field is required.

另外，创建一个validate_foo() 函数来验证foo_object.counter 的限制。

def validate_foo(self, value):
    self.foo_object = get_object_or_404(Foo, pk=value) # get the 'foo' object
    if self.foo_object.counter == 10: # check for limits
        raise serializers.ValidationError('foo limit reached.') # raise error
    return value # must return the value at the end

最终代码：

serializers.py

class BarSerializer(serializers.ModelSerializer):

    class Meta:
        ...
        extra_kwargs = {'foo': {'required':True}} # make 'foo' a required field.

    def validate_foo(self, value):
        self.foo_object = get_object_or_404(Foo, pk=value)
        if self.foo_object.counter == 10: 
            raise serializers.ValidationError('foo limit reached.') 
        return value

views.py

在您看来，您需要覆盖perform_create() 并将user 和serializer.foo_object 传递给serializer.save() 函数。

class BarView(CreateAPIView):
    serializer_class = BarSerializer
    queryset = Bar.objects.all()

    def perform_create(self, serializer):
        return serializer.save(user=self.request.user, foo=serializer.foo_object)

Answer 3

您可以使用用户定义的消息返回Response

if 'foo' not in self.request.data:
    return Response({"foo":["This field is required."]})