In this tutorial, our goal is to learn how to create API views and serializers using Django REST framework.
You will learn how to serialize your data, which means converting complex data types, such as querysets and model instances, into Python data types. You'll also build the logic for your API's endpoints, creating views that handle incoming HTTP requests to your web application.
Creating a serializer:
from rest_framework import serializers
from .models import Article
class ArticleSerializer(serializers.ModelSerializer):
class Meta:
model = Article
fields = ('id', 'title', 'content')
Here, ArticleSerializer
is a subclass of ModelSerializer
, an in-built class in Django REST framework that provides a shortcut for creating serializers. The Meta
class inside it is specifying which model it should serialize and what fields it should include.
Creating a view:
from rest_framework import viewsets
from .serializers import ArticleSerializer
from .models import Article
class ArticleViewSet(viewsets.ModelViewSet):
queryset = Article.objects.all()
serializer_class = ArticleSerializer
Here, ArticleViewSet
is a subclass of the ModelViewSet
class. It uses the ArticleSerializer
we declared earlier and applies it to all Article
objects.
<ModelName>Serializer
to maintain consistency.ModelViewSet
when you want to provide the full set of standard list, create, retrieve, update, destroy style operations.serializers.ModelSerializer
as it gives you a lot of functionality for free.# models.py
from django.db import models
class Article(models.Model):
title = models.CharField(max_length=100)
content = models.TextField()
def __str__(self):
return self.title
# serializers.py
from rest_framework import serializers
from .models import Article
class ArticleSerializer(serializers.ModelSerializer):
class Meta:
model = Article
fields = ('id', 'title', 'content')
# views.py
from rest_framework import viewsets
from .serializers import ArticleSerializer
from .models import Article
class ArticleViewSet(viewsets.ModelViewSet):
queryset = Article.objects.all()
serializer_class = ArticleSerializer
We have learned how to create serializers and views in Django REST Framework. You now know how to serialize your data and build the logic for your API's endpoints.
Author
with fields name
and email
. Then create a serializer for it.Author
model.Article
to Author
. Update your serializers and views to reflect this change.# models.py
class Author(models.Model):
name = models.CharField(max_length=100)
email = models.EmailField()
# serializers.py
class AuthorSerializer(serializers.ModelSerializer):
class Meta:
model = Author
fields = ('id', 'name', 'email')
# views.py
class AuthorViewSet(viewsets.ModelViewSet):
queryset = Author.objects.all()
serializer_class = AuthorSerializer
# models.py
class Article(models.Model):
title = models.CharField(max_length=100)
content = models.TextField()
author = models.ForeignKey(Author, on_delete=models.CASCADE)
# serializers.py
class ArticleSerializer(serializers.ModelSerializer):
class Meta:
model = Article
fields = ('id', 'title', 'content', 'author')
# views.py
class ArticleViewSet(viewsets.ModelViewSet):
queryset = Article.objects.all()
serializer_class = ArticleSerializer
You can now proceed to learn more about Django REST Framework's features like authentication and permissions.