ModelSerializer for model-backed APIs in Django - Mini Project: Build & Apply

ModelSerializer for model-backed APIs

📖 Scenario: You are building a simple API for a bookstore. You want to create a serializer that automatically converts your Book model instances into JSON format and back, so your API can send and receive book data easily.

🎯 Goal: Create a BookSerializer using Django REST Framework's ModelSerializer that maps to the Book model with fields title, author, and published_year.

📋 What You'll Learn

Create a Book model with fields title (CharField), author (CharField), and published_year (IntegerField).

Create a serializer class called BookSerializer using ModelSerializer.

Configure BookSerializer to use the Book model and include the fields title, author, and published_year.

Ensure the serializer can be used to convert model instances to JSON and validate incoming data.

💡 Why This Matters

🌍 Real World

APIs often need to send and receive data in JSON format. ModelSerializer helps convert database models to JSON easily.

💼 Career

Knowing how to use ModelSerializer is essential for backend developers working with Django REST Framework to build clean, maintainable APIs.

1

Create the Book model

Create a Django model called Book with these exact fields: title as a CharField with max length 100, author as a CharField with max length 100, and published_year as an IntegerField.

Django

# Define the Book model here
# Your code here

Need a hint?

Use models.CharField for text fields and models.IntegerField for numbers.

2

Import ModelSerializer

Import ModelSerializer from rest_framework.serializers to prepare for creating the serializer.

Django

from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=100)
    author = models.CharField(max_length=100)
    published_year = models.IntegerField()

# Import ModelSerializer from rest_framework.serializers
# Your code here

Need a hint?

Use from rest_framework.serializers import ModelSerializer.

3

Create the BookSerializer class

Create a serializer class called BookSerializer that inherits from ModelSerializer. Inside it, create a Meta class that sets model = Book and fields = ['title', 'author', 'published_year'].

Django

from django.db import models
from rest_framework.serializers import ModelSerializer

class Book(models.Model):
    title = models.CharField(max_length=100)
    author = models.CharField(max_length=100)
    published_year = models.IntegerField()

# Create BookSerializer class here
# Your code here

Need a hint?

Remember to indent the Meta class inside BookSerializer.

4

Complete the serializer setup

Ensure the BookSerializer class is fully defined with the Meta class inside it specifying the Book model and the fields title, author, and published_year. This completes the serializer setup for your API.

Django

from django.db import models
from rest_framework.serializers import ModelSerializer

class Book(models.Model):
    title = models.CharField(max_length=100)
    author = models.CharField(max_length=100)
    published_year = models.IntegerField()

class BookSerializer(ModelSerializer):
    class Meta:
        model = Book
        fields = ['title', 'author', 'published_year']

# Finalize the serializer setup
# Your code here

Need a hint?

Check that the serializer class and Meta class are correctly indented and complete.