Snippet

Django REST Framework Benutzerdefinierte Serialisierer mit SerializerMethodField

Benutzerdefinierte Serialisierer in Django REST Framework ermöglichen es Ihnen, Modelldaten in JSON-Darstellungen zu transformieren, die auf Ihre API-Anforderungen zugeschnitten sind. Das SerializerMethodField ist besonders nützlich, wenn Sie Werte berechnen müssen, die nicht direkt im Model vorhanden sind, wie z.B. ein vollständiger Name eines Benutzers, der Vorname und Nachname kombiniert, oder aggregierte Daten wie Artikelanzahl.

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

Erklärung

from rest_framework import serializers

Importiere das serializers-Modul von DRF für ModelSerializer und benutzerdefinierte Feldtypen

from django.contrib.auth.models import User

Importiere Djangos eingebautes User-Model zum Serialisieren von Benutzerdaten

full_name = serializers.SerializerMethodField()

Definiere ein berechnetes Feld, das die Methode get_full_name aufruft, um Vor- und Nachname zu kombinieren

def get_full_name(self, obj):

Benutzerdefinierte Methode erhält die Modelinstanz als obj und gibt den berechneten Wert zurück

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

Formatiere den Namen sicher, gebe Benutzernamen zurück, wenn Vor-/Nachname leer sind

def get_article_count(self, obj):

Ein weiteres SerializerMethodField, das über die Reverse-Relation zugehörige Artikel zählt

author = AuthorSerializer(read_only=True)

Verschachtelter Serialisierer bettet den vollständigen AuthorSerializer in ArticleSerializer ein

Vorheriges Snippet Nächstes Snippet

Mehr Python-Übungen für Fortgeschrittene →

Django REST Framework Benutzerdefinierte Serialisierer mit SerializerMethodField

Verwandt