Custom error messages in Django Rest Framework serializer

by

EDIT: I see that this question still receives some views, so it is important to note that there’s another approach, much cleaner than the original answer I posted here.

You can just use the extra_kwargs attribute of the serializer’s Meta class, like so:

class UserSerializer(ModelSerializer):

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

Original answer:

Using @mariodev ‘s answer I created a new class in my project that does that:

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)

The first one gives the possibility to add a new Meta class attribute to the serializer as with the ModelForm.
The second one inherits from ModelSerializer and uses @mariodev’s technique to update the error messages.

All is left to do, is just inherit it, and do something like that:

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

More Related Contents:

  1. Django Rest Framework remove csrf
  2. Django rest framework, use different serializers in the same ModelViewSet
  3. How do I create multiple model instances with Django Rest Framework?
  4. Django rest framework nested self-referential objects
  5. Django REST Framework: adding additional field to ModelSerializer
  6. How to change field name in Django REST Framework
  7. How do you use the django-filter package with a list of parameters?
  8. Django Rest Framework: Dynamically return subset of fields
  9. Django Rest Framework with ChoiceField
  10. SocketException: OS Error: Connection refused, errno = 111 in flutter using django backend
  11. How to set current user to user field in Django Rest Framework?
  12. 405 POST method not allowed
  13. “Post Image data using POSTMAN”
  14. CSRF Failed: CSRF token missing or incorrect
  15. How to register users in Django REST framework?
  16. AngularJS + Django Rest Framework + CORS ( CSRF Cookie not showing up in client )
  17. How do you filter a nested serializer in Django Rest Framework?
  18. How to get Request.User in Django-Rest-Framework serializer?
  19. Pass request context to serializer from Viewset in Django Rest Framework
  20. Django Rest Framework: Disable field update after object is created
  21. Adding root element to json response (django-rest-framework)
  22. Token Authentication for RESTful API: should the token be periodically changed?
  23. Authorization Credentials Stripped — django, elastic beanstalk, oauth
  24. How to programmatically call a Django Rest Framework view within another view?
  25. Django REST Framework image upload
  26. Django/DRF – 405 Method not allowed on DELETE operation
  27. How to pass extra context to Django Rest Framework serializers
  28. How can I test binary file uploading with django-rest-framework’s test client?
  29. Django Rest framework, how to include ‘__all__’ fields and a related field in ModelSerializer ?
  30. context in nested serializers django rest framework

Leave a Comment