Django Rest Framework make OnetoOne relation ship feel like it is one model

by

You can POST and PUT with @kahlo’s approach if you also override the create and update methods on your serializer.

Given a profile model like this:

class Profile(models.Model):
    user = models.OneToOneField(User)
    avatar_url = models.URLField(default="", blank=True)  # e.g.

Here’s a user serializer that both reads and writes the additional profile field(s):

class UserSerializer(serializers.HyperlinkedModelSerializer):
    # A field from the user's profile:
    avatar_url = serializers.URLField(source="profile.avatar_url", allow_blank=True)

    class Meta:
        model = User
        fields = ('url', 'username', 'avatar_url')

    def create(self, validated_data):
        profile_data = validated_data.pop('profile', None)
        user = super(UserSerializer, self).create(validated_data)
        self.update_or_create_profile(user, profile_data)
        return user

    def update(self, instance, validated_data):
        profile_data = validated_data.pop('profile', None)
        self.update_or_create_profile(instance, profile_data)
        return super(UserSerializer, self).update(instance, validated_data)

    def update_or_create_profile(self, user, profile_data):
        # This always creates a Profile if the User is missing one;
        # change the logic here if that's not right for your app
        Profile.objects.update_or_create(user=user, defaults=profile_data)

The resulting API presents a flat user resource, as desired:

GET /users/5/
{
    "url": "http://localhost:9090/users/5/", 
    "username": "test", 
    "avatar_url": "http://example.com/avatar.jpg"
}

and you can include the profile’s avatar_url field in both POST and PUT requests. (And DELETE on the user resource will also delete its Profile model, though that’s just Django’s normal delete cascade.)

The logic here will always create a Profile model for the User if it’s missing (on any update). With users and profiles, that’s probably what you want. For other relationships it may not be, and you’ll need to change the update-or-create logic. (Which is why DRF doesn’t automatically write through a nested relationship for you.)

Related Contents:

  1. Django REST Framework: adding additional field to ModelSerializer
  2. Django REST framework: non-model serializer
  3. What are the differences between django-tastypie and djangorestframework? [closed]
  4. Token Authentication for RESTful API: should the token be periodically changed?
  5. How to register users in Django REST framework?
  6. “Post Image data using POSTMAN”
  7. Django Rest Framework: Disable field update after object is created
  8. Django Rest framework, how to include ‘__all__’ fields and a related field in ModelSerializer ?
  9. Additional field while serializing django rest framework
  10. Django testing rest-framework: APIRequestFactory vs APIClient
  11. This QueryDict instance is immutable
  12. How to query Case-insensitive data in Django ORM?
  13. Get model’s fields in Django
  14. Get class name of django model
  15. Django Rest Framework: Dynamically return subset of fields
  16. How to set a Django model field’s default value to a function call / callable (e.g., a date relative to the time of model object creation)
  17. Getting a count of objects in a queryset in django
  18. How do I create multiple model instances with Django Rest Framework?
  19. In a Django QuerySet, how to filter for “not exists” in a many-to-one relationship
  20. django – get() returned more than one topic
  21. Access Django model’s fields using a string instead of dot syntax?
  22. Django REST Framework – Separate permissions per methods
  23. Django filter the model on ManyToMany count?
  24. Django query datetime for objects older than 5 hours
  25. ‘RelatedManager’ object is not iterable Django
  26. Multiple images per Model
  27. Django: Query using contains each value in a list
  28. generics vs viewset in django rest framework, how to prefer which one to use?
  29. SocketException: OS Error: Connection refused, errno = 111 in flutter using django backend
  30. How to use the ‘reverse’ of a Django ManyToMany relationship?
  31. Django data migration when changing a field to ManyToMany
  32. Django – How to specify which field a validation fails on?
  33. Django – Simple custom template tag example
  34. How can I apply a filter to a nested resource in Django REST framework?
  35. Django comparing model instances for equality
  36. Django: Populate user ID when saving a model
  37. Django print choices value
  38. 405 POST method not allowed
  39. Understanding ManyToMany fields in Django with a through model
  40. What is the canonical way to find out if a Django model is saved to db?
  41. django dynamically filtering with q objects
  42. ChoiceField in Django model
  43. Why does django ORM’s `save` method not return the saved object?
  44. Django: Rest Framework authenticate header
  45. Django accessing ManyToMany fields from post_save signal
  46. Django max_length for IntegerField
  47. Django: Validate file type of uploaded file
  48. django rest framework: set field-level error from serializer validate() method
  49. How can you create a non-empty CharField in Django?
  50. Django model validator not working on create

Leave a Comment