A Django REST Framework (DRF) a Django REST API-k építésének de facto standard-ja, és a serializer-ek az egyik alapvető koncepciója. A serializer komplex adatokat (model instanceket, queryseteket) JSON-vá konvertál az API válaszokhoz, és a bejövő JSON-t vissza validált Python objektumokká alakítja — a sorosítást és validálást egyaránt kezelve, hasonlóan ahogy az űrlapok teszik az HTML-t.
from rest_framework import serializers
from .models import Article
class ArticleSerializer(serializers.ModelSerializer):
class Meta:
model = Article # build from a model (DRY)
fields = ["id", "title", "body", "published", "created_at"]
read_only_fields = ["id", "created_at"]
A ModelSerializer automatikusan generálja a mezőket a modellből (mint a ModelForm) — minimális kód a modell sorosításához és validálásához.
article = Article.objects.get(pk=1)
serializer = ArticleSerializer(article)
serializer.data # {"id": 1, "title": "Hello", "body": "...", ...} → return as JSON
# serialize a queryset (many objects)
serializer = ArticleSerializer(Article.objects.all(), many=True)
serializer.data # a list of dicts
serializer = ArticleSerializer(data=request.data) # incoming JSON
if serializer.is_valid(): # VALIDATE (like a form)
article = serializer.save() # create/update the model
else:
return Response(serializer.errors, status=400) # validation error details
A minta megfelel az űrlapoknak: az is_valid() validálja a bejövő adatokat a mezőszabályok és a modell ellen, és a save() perzisztálja azt. Az érvénytelen adatok strukturált hibaüzeneteket eredményeznek.
class ArticleSerializer(serializers.ModelSerializer):
word_count = serializers.SerializerMethodField() # a computed, read-only field
def get_word_count(self, obj):
return len(obj.body.split())
def validate_title(self, value): # field-level validation
if "spam" in value.lower():
raise serializers.ValidationError("No spam")
return value
class AuthorSerializer(serializers.ModelSerializer):
class Meta: model = Author; fields = ["name"]
class ArticleSerializer(serializers.ModelSerializer):
author = AuthorSerializer(read_only=True) # embed related author data
class Meta: model = Article; fields = ["title", "author"]
A serializer-ek beágyazhatók a kapcsolódó objektumok ábrázolásához (egy szerző adatainak beágyazása egy cikk JSON-jába) — és az API formáját függetlenül az adatbázisérzékű viszonyaitól szabályozhatja.
A serializer-ek a Django REST Framework REST API-k építésének sarokköve, amely a Django API-k standard eszköze — tehát az azok megértése elengedhetetlen bármely modern Django back-end számára, amely JSON-t szolgál ki frontendeknek, mobil alkalmazásoknak vagy más szolgáltatásoknak.
A serializer-ek a két alapvető API-igényt oldják meg: Python/modell adatok JSON-vá konvertálása a válaszokhoz (sorosítás) és a bejövő JSON validált Python objektumokká alakítása az adatok létrehozásához/frissítéséhez (deserialization + validálás).
A validálás aspektusa kritikus a biztonság és robusztusság szempontjából — az HTML-hez hasonlóan az űrlapok, a serializer-ek biztosítják, hogy soha nem bízol meg a nyers API-bemenetben, validálva azt mezőszabályok ellen, mielőtt az adatbázisba érne. A ModelSerializer jelentős termelékenységi nyereséget biztosít a mezők automatikus generálásával a modellekből (DRY, mint a ModelForm), triviálissá téve a modellek API-erőforrásként való kitettségét, míg az is_valid()/save() minta tisztán kezeli a teljes létrehozás/frissítés életciklust.
Annak megértése, hogy miként serializer-ezzünk objektumokat és queryseteket, deseriálozzunk és validáljunk bemeneteket, adjunk hozzá egyéni validálást és számított mezőket, valamint használjunk beágyazott serializer-eket a kapcsolódó adatokhoz (az API formájának szabályozása független az adatbázissémától) alapvető az API-k építéséhez.
A serializer-ek ahol a DRF az API-k alapvető aggályait kezeli az adattranszformáció és validálás terén, ezáltal központiak, elengedhetetlen tudás — hasonló fontosságban az az űrlapok a hagyományos Django-hoz, de az API-vezérelt alkalmazásokhoz, amelyek a modern webes fejlesztést dominálják.