如何为Django Rest Framework(DRF)中的ModelSerializers编写自定义字段验证,类似于Django中的表单验证?

时间:2015-11-16 16:21:00

标签: django django-rest-framework django-validation django-serializer

我目前正在创建一个基于DRF的api。我有一个类似的模型:

class Task(models.Model):
    name = models.CharField(max_length = 255)
    completed = models.BooleanField(default = False)
    description = models.TextField()
    text = models.TextField(blank = False, default = "this is my text" )

    def __unicode__(self):
        return self.name

此模型的相应Serializer如下:

class TaskSerializer(serializers.ModelSerializer):
    class Meta:
        model = Task
        fields = ('name','description','completed','text')

现在我的问题是我想在获取数据时验证模型的'name'字段。 例如,我可能会通过类似于Django表单的Python代码来检查用户的名字或第二名:

def clean_name(self):
    name = form.cleaned_data.get('name')
    first,second = name.split(' ')
    if second is None:
        raise forms.ValidationError("Please enter full name")

我在Serializers.serializer类中知道名为'validate_(fieldname)'的东西。但是我希望在Serializers.ModelSerializer中使用它。(类似于Django中的自定义表单验证)

1 个答案:

答案 0 :(得分:8)

您可以向序列化程序添加validate_name()方法,该方法将执行此验证。它应返回验证值或引发ValidationError

要检查用户是否输入了全名,我们将使用str.split()来返回字符串中的所有字词。如果没有。字符串中的单词不大于1,那么我们将引发ValidationError。否则,我们会返回value

class TaskSerializer(serializers.ModelSerializer):

    def validate_name(self, value):
        """
        Check that value is a valid name.
        """
        if not len(value.split()) > 1: # check name has more than 1 word
            raise serializers.ValidationError("Please enter full name") # raise ValidationError
        return value