customize Django Rest Framework serializers output?

Question

I have a Django model like this:

class Sections(models.Model):
    section_id = models.CharField(max_length=127, null=True, blank=True)
    title = models.CharField(max_length=255)
    description = models.TextField(null=True, blank=True)

class Risk(models.Model):
    title = models.CharField(max_length=256, null=False, blank=False)
    section = models.ForeignKey(Sections, related_name='risks')

class Actions(models.Model):
    title = models.CharField(max_length=256, null=False, blank=False)
    section = models.ForeignKey(Sections, related_name='actions')

And serializers like that :

class RiskSerializer(serializers.ModelSerializer):
    class Meta:
        model = Risk
        fields = ('id', 'title',)

class ActionsSerializer(serializers.ModelSerializer):
    class Meta:
        model = Actions
        fields = ('id', 'title',)

class RiskActionPerSectionsSerializer(serializers.ModelSerializer):
   risks = RiskSerializer(many=True, read_only=True)
   actions = ActionsSerializer(many=True, read_only=True)

   class Meta:
        model = Sections
        fields = ('section_id', 'risks', 'actions')
        depth = 1

When accessing the RiskActionPerSectionSerializer over a view, I get the following output:

[
{
    "actions": [
        {
            "id": 2, 
            "title": "Actions 2"
        }, 
        {
            "id": 1, 
            "title": "Actions 1"
        }
    ], 
    "risks": [
        {
            "id": 2, 
            "title": "Risk 2"
        }, 
        {
            "id": 1, 
            "title": "Risk 1"
        }
    ], 
    "section_id": "section 1"
}
.....
]

It s fine but I would prefer to have that :

{
"section 1": {
    "risks": [
        {
          "id": 2,
          "title": "Risk 2"
        }, 
        {
          "id": 1,
          "title": "Risk 1"
        }
    ],
    "actions": [
        {
          "id": 2,
          "title": "Actions 2"
        }, 
        {
          "id": 1,
          "title": "Actions 1"
        }
   ]
}
}

How can I do that with Django Rest Framework ?

Ivan Semochkin · Accepted Answer · 2016-09-13 09:04:11Z

9

You could override to_representation() method of your serializer:

class RiskActionPerSectionsSerializer(serializers.ModelSerializer):

   class Meta:
       model = Sections
       fields = ('section_id', 'risks', 'actions')
       depth = 1

   def to_representation(self, instance):
       response_dict = dict()
       response_dict[instance.section_id] = {
           'actions': ActionsSerializer(instance.actions.all(), many=True).data,
           'risks': RiskSerializer(instance.risks.all(), many=True).data
       }
       return response_dict

edited Sep 13, 2016 at 9:04

answered Jul 25, 2016 at 13:01

Ivan Semochkin

8,9173 gold badges49 silver badges78 bronze badges

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

2 Comments

user659154 Over a year ago

How can I change the output structure to be more like this: [ "section1": { "actions": [], "risks": [] }, "section2": { "actions": [], "risks": [] }, ]

Ivan Semochkin Over a year ago

@user659154 You better ask new question, I can't figure it out now

Collectives™ on Stack Overflow

customize Django Rest Framework serializers output?

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related