django rest framework: customize nested serializer

Question

I have the following Django model structure:

class TypeOfIngredient(models.Model):
    name = models.CharField(max_length=200,unique=True,null=False)
    slug = models.SlugField(unique=True)

class Ingredient(models.Model):
    name = models.CharField(max_length=200,unique=True,null=False)
    slug = models.SlugField(unique=True)
    typeofingredient = models.ForeignKey(TypeOfIngredient, related_name='typeof_ingredient',null=True, blank=True,on_delete=models.PROTECT)

Serializer:

class IngredientListSerializer(ModelSerializer):
    class Meta:
        model = Ingredient
        fields = '__all__'

With the above serializer i see the following api output:

"results": [
        {
            "id": 1,
            "name": "adrak",
            "slug": "adrak",
            "typeofingredient": null
        },
        {
            "id": 2,
            "name": "banana",
            "slug": "banana",
            "typeofingredient": 1
        },

How to get "typeofingredient": "fruit" where fruit is the name field of the typeofingredient. What i am getting is the id.

I tried nested:

class IngredientListSerializer(ModelSerializer):
    class Meta:
        model = Ingredient
        fields = '__all__'
        depth = 1

Then i get the api output as:

"results": [
        {
            "id": 1,
            "name": "adrak",
            "slug": "adrak",
            "typeofingredient": null
        },
        {
            "id": 2,
            "name": "banana",
            "slug": "banana",
            "typeofingredient": {
                    "id": 1,
                    "name": "fruit",
                    "slug": "fruit"
            }
        },

Here is showing all the details of the typeofingredient. Rather than this can i have directly "typeofingredient": "fruit"

Satendra · Accepted Answer · 2017-11-19 12:22:12Z

1

Use serializers.ReadOnlyField

class IngredientListSerializer(ModelSerializer):
    typeofingredient = serializers.ReadOnlyField(source='typeofingredient.name')    

    class Meta:
        model = Ingredient
        fields = '__all__'

answered Nov 19, 2017 at 12:22

Satendra

6,8554 gold badges29 silver badges48 bronze badges

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

2 Comments

Santhosh Over a year ago

Can you guide me why we use ReadOnlyField. I am quite new to serializers

Satendra Over a year ago

A field class that simply returns the value of the field without modification. ReadOnlyField

Shaon shaonty · Accepted Answer · 2017-11-19 12:24:57Z

1

You can add str method on models.py

class TypeOfIngredient(models.Model):
    name = models.CharField(max_length=200,unique=True,null=False)
    slug = models.SlugField(unique=True)

    def __str__(self):
        return str(self.name)

class Ingredient(models.Model):
    name = models.CharField(max_length=200,unique=True,null=False)
    slug = models.SlugField(unique=True)
    typeofingredient = models.ForeignKey(TypeOfIngredient, related_name='typeof_ingredient',null=True, blank=True,on_delete=models.PROTECT)

answered Nov 19, 2017 at 12:24

Shaon shaonty

1,4251 gold badge13 silver badges23 bronze badges

4 Comments

Shift 'n Tab Over a year ago

this is not what the op want

Shaon shaonty Over a year ago

he wants name instead of id... it returns the TypeOfIngredient name

Shift 'n Tab Over a year ago

well it may solve the problem but not a drf thing, it would be better to offer serializers approach

Santhosh Over a year ago

I am looking for serialzer approach

Collectives™ on Stack Overflow

django rest framework: customize nested serializer

2 Answers 2

2 Comments

4 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

4 Comments

Your Answer

Sign up or log in

Post as a guest

Related