Django Rest框架序列化程序中的自定义错误消息

Question

这个场景非常简单：

我有一个带有一些必填字段的模型。假设其中一个是TextField，它不能为空。我还有一个表示该模型的ModelSerializer（Django Rest框架）。

当使用空字符串通过序列化程序设置该字段时，返回的错误来自模型本身（此字段不能为空）。

我只想在序列化程序级别重写错误消息，而不需要显式地重新指定序列化程序中的每个字段（我认为这违反了DRY原则），必须为每个字段编写一个validate\uuu方法，并提出我自己的ValidationError，或者必须在模型级别更改错误消息（因为有时错误消息的上下文与我的用例有关，并且应该相应地给出错误消息）。

换句话说，有没有一种方法可以像重写模型表单一样轻松地重写序列化程序级别的错误消息：

class MyModelForm(ModelForm):
    class Meta:
        model = MyModel
        error_messages = {"field1": {"required": _("For some reason this is a custom error message overriding the model's default")}}




Answer 1

我试图创建一个简单的序列化程序，而不是模型序列化程序。可能是因为这个原因，加布里埃尔·阿姆拉姆（Gabriel Amram）用extra_-kwargs的公认答案对我不起作用。@mariodev的另一个顶级答案确实有效，但我正在寻找一个更优雅的解决方案，并找到了一个。结果是字段类接受错误消息作为参数，这是一个覆盖默认错误消息的字典。这是文件的参考资料。它的格式与公认答案中描述的格式相同。以下是一个例子：

from rest_framework import serializers

class MySerializer(serializers.Serializer):
    client_id = serializers.IntegerField(required=True, error_messages={'required': 'Custom error message'})

Answer 2

在序列化程序中：

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User

    def __init__(self, *args, **kwargs):
        super(UserSerializer, self).__init__(*args, **kwargs)

        self.fields['username'].error_messages['required'] = u'My custom required msg'

请注意，一些错误消息包含%s占位符，如：

'invalid': _("'%s' value must be either True or False."),

对于布尔字段。

因此，您需要查看DRF的字段中每个字段类型中的default\u error\u消息。py，以正确使用它。

Answer 3

编辑：我看到这个问题仍然收到一些意见，所以重要的是要注意还有另一种方法，比我在这里发布的原始答案更清晰。

您只需使用序列化程序的元类的extra_kwargs属性，如下所示：

class UserSerializer(ModelSerializer):

    class Meta:
        model = User
        extra_kwargs = {"username": {"error_messages": {"required": "Give yourself a username"}}}

原始答复：

使用@mariodev的答案，我在我的项目中创建了一个新类，它可以：

from rest_framework.serializers import ModelSerializer, ModelSerializerOptions

class CustomErrorMessagesModelSerializerOptions(ModelSerializerOptions):
    """
    Meta class options for CustomErrorMessagesModelSerializerOptions
    """
    def __init__(self, meta):
        super(CustomErrorMessagesModelSerializerOptions, self).__init__(meta)
        self.error_messages = getattr(meta, 'error_messages', {})

class CustomErrorMessagesModelSerializer(ModelSerializer):
    _options_class = CustomErrorMessagesModelSerializerOptions

    def __init__(self, *args, **kwargs):
        super(CustomErrorMessagesModelSerializer, self).__init__(*args, **kwargs)

        # Run through all error messages provided in the Meta class and update
        for field_name, err_dict in self.opts.error_messages.iteritems():
            self.fields[field_name].error_messages.update(err_dict)

第一种方法提供了向序列化程序添加新的Meta类属性的可能性，就像ModelForm一样。第二个继承自ModelSerializer，并使用@mariodev的技术更新错误消息。

剩下要做的就是继承它，然后做类似的事情：

class UserSerializer(CustomErrorMessagesModelSerializer):
    class Meta:
        model = User
        error_messages = {"username": {"required": "Give yourself a username"}}