Django Rest Framework: how do I Display content of Foreign keys in JSON

Question

I have serialised a model into JSON that has foreign keys. The API will show the title of the foreign key but will not nest the data that belongs to that foreign key. How do I do this.

serializers.py

class ReportFieldSerializers(serializers.ModelSerializer):
    form = serializers.RelatedField()
    class Meta:
        model = ReportField
        fields = (
            'id',
            'title',
            'form'
        )

api.py

class ReportFieldList(APIView):
    def get(self, request, format=None):
        report_field = ReportField.objects.all()
        serialized_report_field = ReportFieldSerializers(report_field, many=True)
        return Response(serialized_report_field.data)

class ReportFieldDetail(APIView):
    def get_object(self, pk):
        try:
            return ReportField.objects.get(pk=pk)
        except ReportField.DoesNotExist:
            raise Http404

    def get(self, request, pk, format=None):
        report_field = self.get_object(pk)
        serialized_report_field = ReportFieldSerializers(report_field)
        return Response(serialized_report_field.data)

models.py

class Report(models.Model):
    title = models.CharField()
    form = models.ForeignKey()

class Form(models.Model):
    # Form details

You have ReportField in your serializers.py, but a model Report in your models.py. Can you please correct that to reflect your actual code. — cezar
– cezar, Commented Nov 3, 2014 at 19:43

Community · Accepted Answer · 2017-05-23 10:31:25Z

7

There is an option depth, that can be used in the Meta class of the serializer. For example:

class ReportFieldSerializers(serializers.ModelSerializer):

    class Meta:
        model = ReportField
        fields = (
            'id',
            'title',
            'form'
        )
        depth = 1

This will go one step down in the related models. As you see you don't need the RelatedField. If, let's say, there would be a third model class, for example:

class Form(models.Model):
    example = ForeignKey('AnotherModel')

class AnotherModel(models.Model):
    # model fields

you could also use depth=2 in your ReportFieldSerializer to display the information for this model.

I assume that in your model Report the field form shows to Form: models.ForeignKey(Form).

I answered already a similar question here: Django rest_framework serializer with inner relationship

edited May 23, 2017 at 10:31

CommunityBot

11 silver badge

answered Nov 3, 2014 at 19:37

cezar

12.1k6 gold badges51 silver badges92 bronze badges

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

1 Comment

yev Over a year ago

This helped me. Is it possible to remove the id field of the foreign key altogether? Or am looking at it the wrong way? I'm new to django, I was thinking it defeats the purpose of hiding the id field on the foreign model's serializer if it will be just displayed as well if taken from the other object. Is there a reason that i'm missing? Is it perhaps for accessing?

Collectives™ on Stack Overflow

Django Rest Framework: how do I Display content of Foreign keys in JSON

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related