Django Rest framework, how to include 'all' fields and a related field using foreignkey_id field

Question

So here is my files - Models.py

class Model1(models.Model):
    user = models.ForeignKey(User)
    other_fields = models.CharField(max_length=40)

Serializers.py

class MySerializer(ModelSerializer):
    class Meta:
        model = Model1
        fields = '__all__'


Here  json request
{"user_id":1, "other_fields":"details"}

and in views.py

serializer = MySerializer(data=request.data)
serializer.data

**Throws keyerror "user"**

When i try to change request parameter "user_id" to "user" it works for me . But I can't change request json. Is there any way to handle this issue in serializer?

I can set all the fields inplace of '_all_' but it is not a good solution due to large number of fields .

I also tried with -

 class MySerializer(ModelSerializer):
    user = serializers.CharField(source='user_id')
    class Meta:
        model = Model1
        fields = '__all__'

but it was not worked for me.

Why not try to use exclude param in your Meta class, pass it a tuple of not required fields. — julian salas
– julian salas, Commented Sep 4, 2018 at 13:52
Are you trying to get all the field on the User model as well ? — Tobey
– Tobey, Commented Sep 4, 2018 at 13:59
Usually, __all__ will include all model fields + fields included explicitly in serializer — JPG
– JPG, Commented Sep 4, 2018 at 14:10

Ehsan Nouri · Accepted Answer · 2018-09-04 14:42:39Z

1

try this:

class MySerializer(ModelSerializer):
    user_id = serializers.PrimaryKeyRelatedField(queryset=User.objects.all(), source='user', write_only=True)
    class Meta:
        model = Model1
        fields = '__all__'

answered Sep 4, 2018 at 14:42

Ehsan Nouri

2,04013 silver badges18 bronze badges

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

Comments

JPG · Accepted Answer · 2018-09-04 14:40:12Z

1

I assume you are using viewset class for your views. then this will work

Override the __init__ method as,

class MySerializer(ModelSerializer):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        if 'view' in self.context and self.context['view'].action in ['create', 'update', 'partial_update']:
            self.fields['user_id'] = self.fields.pop('user')

    class Meta:
        model = Model1
        fields = '__all__'

The ['create', 'update', 'partial_update'] are the actions of viewset class which are representing HTTP POST, HTTP PUT and HTTP PATCH respectively.

answered Sep 4, 2018 at 14:40

JPG

89.4k24 gold badges164 silver badges235 bronze badges

Comments

Tobey · Accepted Answer · 2018-09-04 14:43:21Z

1

Try using PrimaryKeyRelatedField

class MySerializer(ModelSerializer):

    def to_internal_value(self, data):
        data = data.copy() # incase request data is immutable
        data['user'] = data['user_id']
        return super().to_internal_value(data)

    user = serializers.PrimaryKeyRelatedField(queryset=User.objects.all())

    class Meta:
        model = Model1
        fields = '__all__'

This should allow for payload:

 {"user_id": 1, "other_fields": "details"}

edited Sep 4, 2018 at 14:43

answered Sep 4, 2018 at 14:21

Tobey

1,4401 gold badge11 silver badges25 bronze badges

Collectives™ on Stack Overflow

Django Rest framework, how to include 'all' fields and a related field using foreignkey_id field

3 Answers 3

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related