Snippet

Django REST Framework Custom Serializers with SerializerMethodField

Custom serializers in Django REST Framework allow you to transform model data into JSON representations tailored to your API needs. The SerializerMethodField is particularly useful when you need to compute values that don't exist directly on the model, such as a user's full name combining first and last name, or aggregated data like article counts.

snippet.py

python

from rest_framework import serializers
from django.contrib.auth.models import User
from .models import Article
 
class AuthorSerializer(serializers.ModelSerializer):
    full_name = serializers.SerializerMethodField()
    article_count = serializers.SerializerMethodField()
    
    class Meta:
        model = User
        fields = ['id', 'username', 'full_name', 'article_count']
    
    def get_full_name(self, obj):
        return f"{obj.first_name} {obj.last_name}".strip() or obj.username
    
    def get_article_count(self, obj):
        return obj.articles.count()
 
class ArticleSerializer(serializers.ModelSerializer):
    author = AuthorSerializer(read_only=True)
    tags = serializers.StringRelatedField(many=True)
    
    class Meta:
        model = Article
        fields = ['id', 'title', 'content', 'author', 'tags', 'created_at']

django

Breakdown

from rest_framework import serializers

Import the serializers module from DRF to access ModelSerializer and custom field types

from django.contrib.auth.models import User

Import Django's built-in User model to serialize user data

full_name = serializers.SerializerMethodField()

Define a computed field that calls get_full_name method to combine first and last name

def get_full_name(self, obj):

Custom method receives the model instance as obj and returns computed value

return f"{obj.first_name} {obj.last_name}".strip() or obj.username

Format name safely, returning username if first/last name are empty

def get_article_count(self, obj):

Another SerializerMethodField that counts related articles via reverse relation

author = AuthorSerializer(read_only=True)

Nested serializer embeds full AuthorSerializer within ArticleSerializer for nested JSON output

Previous snippet Next snippet

More Intermediate Python exercises →