Error codes while form validation in django rest framework

Question

Is there a nice and clean way to use custom error codes while form validation? Eg:

{
    "name": {
        "code": 121,
        "message": "This field can't be blank."
    }
}

instead of:

{
    "name": ["This field can't be blank."]
}

Thank you.

Sevle · Accepted Answer · 2016-02-28 11:24:10Z

1

You can overwrite the error message in the __init__ method of your serializer:

self.fields['field_name'].error_messages['error_message_key'] = your_custom_error

You can find all error_messages keys related to each Field in the documentation. For instance, CharFields error message keys are required, max_length, min_length.

If you're using custom field from DRF:

name = serializers.CharField(
    ...,
    error_messages={error_message_key: your_custom_error}
)

If you want to raise more specific errors, I encourage you to take a look at Raising ValidationError from the official documentation and ValidationError from DRF documentation.

edited Feb 28, 2016 at 11:24

Sevle

3,1192 gold badges22 silver badges32 bronze badges

answered Dec 16, 2015 at 11:30

tcollart

1,0722 gold badges18 silver badges31 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

User Over a year ago

This does not work. DRF requires string, not a dict => "AttributeError: 'dict' object has no attribute 'format'"

Collectives™ on Stack Overflow

Error codes while form validation in django rest framework

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related