Django Rest Framework List of Strings Serializer

Question

I have two models created in my Django app and am looking for a serialization approach so that the IPs are shown in JSON as a list of strings instead of a list of IPAddress objects.

Desired JSON

[
    {
        "hostname": "www.example.com",
        "ip_addresses": [ "1.1.1.1", "2.2.2.2" ]
    }
]

Current JSON

[
    {
        "hostname": "www.example.com",
        "ip_addresses": [
            {
                "id": 1,
                "ip_address": "1.1.1.1"
            },
            {
                "id": 2,
                "ip_address": "2.2.2.2"
            }
        ]
]

urls.py

class HostSerializer(serializers.ModelSerializer):
    hostname = serializers.CharField(source='name', read_only=True)

    class Meta:
        model = Host
        fields = ['hostname', 'ip_addresses']
        depth = 1

models.py

class IPAddress(models.Model):
    ip_address = models.GenericIPAddressField()

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

class Host(models.Model):
    name = models.CharField(max_length=100)
    ip_addresses = models.ManyToManyField(IPAddress)

    def __str__(self):
        return self.name

Bishnu Sharma · Accepted Answer · 2020-07-09 18:47:16Z

1

Try out this !

class HostSerializer(serializers.Serializer):
    hostname = serializers.CharField(source='name', read_only=True)
    ip_addresses = serializers.SerializerMethodField(read_only=True)

    def get_ip_addresses(self, instance):
        return [item.ip_address for item in instance.ip_addresses.all()]

answered Jul 9, 2020 at 18:47

Bishnu Sharma

1631 silver badge9 bronze badges

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

1 Comment

Harun Yilmaz Over a year ago

You don't need to add read_only=True to SerializerMethodField since it is already read-only.

Harun Yilmaz · Accepted Answer · 2020-07-09 13:22:20Z

0

You can use serializers.SerializerMethodField() to achieve what you want:

class HostSerializer(serializers.ModelSerializer):
    hostname = serializers.CharField(source='name', read_only=True)
    ip_addresses: serializers.SerializerMethodField()

    class Meta:
        model = Host
        fields = ['hostname', 'ip_addresses']
        depth = 1

    def get_ip_addresses(self, instance):
        return [item.ip_address for item in instance.ip_addresses]

answered Jul 9, 2020 at 13:22

Harun Yilmaz

8,5793 gold badges30 silver badges40 bronze badges

2 Comments

steelcityamir Over a year ago

Hmm still getting the same JSON response

Harun Yilmaz Over a year ago

@kernelpanic Looks like I forgot to add all() to get instance.ip_addresses :)

Collectives™ on Stack Overflow

Django Rest Framework List of Strings Serializer

2 Answers 2

1 Comment

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related