Specify related string field in Django Rest Framework

Question

Django 1.11, Django Rest Framework 3.6.

I have 2 models, Foo and Bar:

class Foo(models.Model):
    name=models.CharField()
    sex=models.CharField()

class Bar(models.Model):
    type=models.CharField()
    foo=models.ForeignKey(Foo)

In my serializers.py I have:

class FooSerializer(serializers.ModelSerializer):
    class Meta:
        model = Foo
        fields = ('sex',)

class BarSerializer(serializers.ModelSerializer):
    foo = FooSerializer(many=False)
    class Meta:
        model = Bar
        fields = ('type', 'foo',)

This produces JSON like this:

{
  "type": "abcdefg",
  "foo": {
    "sex": "male"
  }
}

What I really want is for the "foo" field to be flat, i.e.:

{
  "type": "abcdefg",
  "foo": "male"
}

One possible solution would be to use the StringRelatedField, but this would entail setting the __str__ method of the Foo model to return the sex field, which I do not want.

Daniel Roseman · Accepted Answer · 2019-01-23 15:17:20Z

1

An easier alternative is to use SlugRelatedField, which can be pointed at any field.

class BarSerializer(serializers.ModelSerializer):
    foo = SlugRelatedField(slug_field='sex')
    class Meta:
        model = Bar
        fields = ('type', 'foo',)

answered Jan 23, 2019 at 15:17

Daniel Roseman

602k68 gold badges910 silver badges923 bronze badges

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

1 Comment

GluePear Over a year ago

Easier, but a bit misleading perhaps?

Ngoc Pham · Accepted Answer · 2019-01-23 11:10:43Z

0

you can try SerializerMethodField instead of.

class BarSerializer(serializers.ModelSerializer):
    foo = serializers.SerializerMethodField()

    @staticmethod
    def get_foo(item):
        if item.foo:
           return item.foo.sex

    class Meta:
        model = Bar
        fields = ('type', 'foo',)

answered Jan 23, 2019 at 11:10

Ngoc Pham

1,4509 silver badges22 bronze badges

Collectives™ on Stack Overflow

Specify related string field in Django Rest Framework

2 Answers 2

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related