How to change field name in Django REST Framework

by

There is a very nice feature in serializer fields and serializers in general called ‘source’ where you can specify source of data from the model field.

class ParkSerializer(serializers.ModelSerializer):
    location = serializers.SomeSerializerField(source="alternate_name")

    class Meta:
        model = Park
        fields = ('other_fields', 'location')

Where serializers.SomeSerializerField can be serializers.CharField as your model suggests but can also be any of the other fields. Also, you can put relational fields and other serializers instead and this would still work like charm. ie even if alternate_name was a foreignkey field to another model.

class ParkSerializer(serializers.ModelSerializer):
    locations = AlternateNameSerializer(source="alternate_name", many=true)

    class Meta:
        model = Park
        fields = ('other_fields', 'locations')

class AlternateNameSerializer(serializers.ModelSerialzer):
    class Meta:
        model = SomeModel

This works with the creation, deletion, and modification requests too. It effectively creates one on one mapping of the field name in the serializer and field name in models.

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. Custom error messages in Django Rest Framework serializer
  6. Django REST Framework: adding additional field to ModelSerializer
  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