Browsable API interface in Django - Mini Project: Build & Apply

Browsable API interface

📖 Scenario: You are building a simple web API for a bookstore. You want to create an API endpoint that returns a list of books. To make it easy for users and developers to explore your API, you want to enable the browsable API interface provided by Django REST Framework.

🎯 Goal: Build a Django REST Framework API view that returns a list of books and supports the browsable API interface for easy exploration in a web browser.

📋 What You'll Learn

Create a Django model called Book with fields title and author

Create a serializer called BookSerializer for the Book model

Create a view called BookList using Django REST Framework's generic views

Configure the URL pattern to route /books/ to the BookList view

Enable the browsable API interface by setting the correct renderer classes

💡 Why This Matters

🌍 Real World

Browsable API interfaces help developers and users explore and test APIs easily in a web browser without extra tools.

💼 Career

Knowing how to build and configure browsable APIs is essential for backend developers working with Django REST Framework to create user-friendly APIs.

1

DATA SETUP: Create the Book model

Create a Django model called Book in models.py with two fields: title as a CharField with max length 100, and author as a CharField with max length 100.

Django

# Your code here

Need a hint?

Think of a book as having a title and an author, both short text fields.

2

CONFIGURATION: Create the BookSerializer

Create a serializer called BookSerializer in serializers.py that serializes the Book model with all fields.

Django

from django.db import models

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

# Your code here

Need a hint?

Use ModelSerializer to quickly create a serializer for the Book model.

3

CORE LOGIC: Create the BookList API view with browsable interface

Create a view called BookList in views.py using Django REST Framework's generics.ListAPIView. Set the queryset to all Book objects, the serializer_class to BookSerializer, and set renderer_classes to include JSONRenderer and BrowsableAPIRenderer.

Django

from django.db import models

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

from rest_framework import serializers

class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = '__all__'

# Your code here

Need a hint?

Use ListAPIView for a read-only list and add both JSONRenderer and BrowsableAPIRenderer to renderer_classes.

4

COMPLETION: Add URL pattern for the BookList view

In urls.py, import BookList from views and add a URL pattern that routes path('books/', BookList.as_view()) to the BookList view.

Django

from django.db import models

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

from rest_framework import serializers

class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = '__all__'

from rest_framework import generics
from rest_framework.renderers import JSONRenderer, BrowsableAPIRenderer

class BookList(generics.ListAPIView):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    renderer_classes = [JSONRenderer, BrowsableAPIRenderer]

# Your code here

Need a hint?

Use path to connect the URL books/ to the BookList.as_view().