Why DRF matters for APIs in Django - See It in Action

Why DRF Matters for APIs

📖 Scenario: You are building a simple web API to share book information. You want to create the data, configure a setting, write the main logic to expose the data as an API, and complete the setup so the API works properly.

🎯 Goal: Build a basic Django REST Framework (DRF) API that returns a list of books with their titles and authors.

📋 What You'll Learn

Create a list of dictionaries with book data

Add a configuration variable for API version

Use DRF's APIView to create an API endpoint

Complete the URL routing to connect the API view

💡 Why This Matters

🌍 Real World

APIs are how apps and websites share data. DRF makes building APIs in Django easier and faster.

💼 Career

Knowing DRF is important for backend developers working with Django to create clean, maintainable APIs.

1

DATA SETUP: Create the book data list

Create a variable called books that is a list containing these exact dictionaries: {'title': 'The Hobbit', 'author': 'J.R.R. Tolkien'} and {'title': '1984', 'author': 'George Orwell'}.

Django

# Create the books list with two dictionaries
# Your code here

Hint

Use a list with two dictionaries exactly as shown.

2

CONFIGURATION: Add API version variable

Create a variable called API_VERSION and set it to the string 'v1'.

Django

books = [
    {'title': 'The Hobbit', 'author': 'J.R.R. Tolkien'},
    {'title': '1984', 'author': 'George Orwell'}
]
# Define API_VERSION variable
# Your code here

Hint

Set API_VERSION exactly to 'v1'.

3

CORE LOGIC: Create a DRF APIView to return books

Import APIView and Response from rest_framework.views and rest_framework.response respectively. Then create a class called BookList that inherits from APIView. Inside it, define a get method that takes self and request and returns a Response with the books list.

Django

books = [
    {'title': 'The Hobbit', 'author': 'J.R.R. Tolkien'},
    {'title': '1984', 'author': 'George Orwell'}
]

API_VERSION = 'v1'

# Import APIView and Response
# Create BookList class with get method
# Your code here

Hint

Use DRF's APIView and Response to create the API endpoint.

4

COMPLETION: Add URL pattern for the API view

Import path from django.urls. Then create a variable called urlpatterns that is a list containing a single path with the route 'api/v1/books/' (use the API_VERSION variable), the view BookList.as_view(), and the name 'book-list'.

Django

from rest_framework.views import APIView
from rest_framework.response import Response

books = [
    {'title': 'The Hobbit', 'author': 'J.R.R. Tolkien'},
    {'title': '1984', 'author': 'George Orwell'}
]

API_VERSION = 'v1'

class BookList(APIView):
    def get(self, request):
        return Response(books)

# Import path and create urlpatterns list
# Your code here

Hint

Use path with the route using API_VERSION and connect it to BookList.as_view().

Practice

1. Why is Django REST Framework (DRF) important when building APIs in Django?

easy

A. It simplifies API development by providing tools like serializers and viewsets.

B. It replaces Django's ORM for database management.

C. It is used only for building web pages, not APIs.

D. It automatically creates frontend user interfaces.

Solution

1. Step 1: Understand DRF's role in API development

   DRF provides serializers and viewsets that help organize API code and handle data conversion.

2. Step 2: Compare DRF with other Django features

   Django's ORM manages databases, but DRF focuses on API creation, not replacing ORM or frontend UI.

3. Final Answer:

   It simplifies API development by providing tools like serializers and viewsets. -> Option A

4. Quick Check:

   DRF simplifies API building = B [OK]

Hint: DRF helps build APIs faster with ready tools [OK]

Common Mistakes:

• Thinking DRF replaces Django ORM
• Confusing DRF with frontend frameworks
• Believing DRF only builds web pages

2. Which of the following is the correct way to import the serializer class from DRF?

easy

A. import rest_framework.Serializer

B. import django.serializers.Serializer

C. from django.rest_framework import Serializer

D. from rest_framework.serializers import Serializer

Solution

1. Step 1: Recall DRF import paths

   DRF's serializers are imported from rest_framework.serializers module.

2. Step 2: Check each option's syntax

   Only from rest_framework.serializers import Serializer uses the correct module path and syntax for importing Serializer.

3. Final Answer:

   from rest_framework.serializers import Serializer -> Option D

4. Quick Check:

   Correct DRF import syntax = A [OK]

Hint: DRF serializers come from rest_framework.serializers [OK]

Common Mistakes:

• Using django instead of rest_framework in import
• Wrong module paths causing ImportError
• Confusing package names

3. Given this DRF viewset code, what will be the output when accessing the API endpoint?

from rest_framework import viewsets
from myapp.models import Item
from myapp.serializers import ItemSerializer

class ItemViewSet(viewsets.ModelViewSet):
    queryset = Item.objects.all()
    serializer_class = ItemSerializer

medium

A. An error because viewsets.ModelViewSet is not valid.

B. A plain text list of Item objects without formatting.

C. A browsable API showing all Item objects with CRUD options.

D. A JSON response with only the first Item object.

Solution

1. Step 1: Understand ModelViewSet behavior

   ModelViewSet provides a full set of API views with list, create, retrieve, update, and delete actions.

2. Step 2: Recognize DRF's browsable API feature

   DRF automatically provides a browsable web interface for API endpoints using ModelViewSet.

3. Final Answer:

   A browsable API showing all Item objects with CRUD options. -> Option C

4. Quick Check:

   ModelViewSet gives browsable API with full CRUD = C [OK]

Hint: ModelViewSet gives full API with browsable interface [OK]

Common Mistakes:

• Thinking ModelViewSet returns plain text
• Assuming it returns only one object
• Believing ModelViewSet is invalid

4. What is wrong with this DRF serializer code?

from rest_framework import serializers

class UserSerializer(serializers.Serializer):
    username = serializers.CharField(max_length=100)
    email = serializers.EmailField()

    def create(self, validated_data):
        return User.objects.create(validated_data)

medium

A. Serializer classes cannot define create methods.

B. The create method should unpack validated_data with ** before passing to create().

C. CharField does not accept max_length argument.

D. EmailField is not a valid serializer field.

Solution

1. Step 1: Review create method usage

   The create method must pass validated_data as keyword arguments using ** to User.objects.create().

2. Step 2: Check other parts for errors

   EmailField and CharField usage are correct; serializers can define create methods.

3. Final Answer:

   The create method should unpack validated_data with ** before passing to create(). -> Option B

4. Quick Check:

   Use **validated_data in create() = D [OK]

Hint: Use ** to unpack validated_data in create() [OK]

Common Mistakes:

• Passing dict directly without unpacking
• Thinking EmailField is invalid
• Believing serializers can't have create methods

5. You want to build an API that returns only active users with their username and email. Which DRF components should you combine to achieve this cleanly and efficiently?

hard

A. Use a ModelViewSet with a serializer that includes username and email fields, and filter queryset for active users.

B. Write raw SQL queries and return plain JSON responses manually.

C. Use Django templates to render user data as HTML pages.

D. Create a custom middleware to filter users and serialize data.

Solution

1. Step 1: Identify DRF components for API

   ModelViewSet provides API endpoints; serializers define which fields to include.

2. Step 2: Apply filtering and field selection

   Filter the queryset to active users and use serializer to include only username and email.

3. Final Answer:

   Use a ModelViewSet with a serializer that includes username and email fields, and filter queryset for active users. -> Option A

4. Quick Check:

   ModelViewSet + filtered queryset + serializer fields = A [OK]

Hint: Combine ModelViewSet, serializer, and queryset filter [OK]

Common Mistakes:

• Using raw SQL instead of DRF tools
• Rendering HTML instead of JSON API
• Trying to filter users in middleware