ViewSets and routers in Django - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a ViewSet in Django REST Framework?

A ViewSet is a class that groups related views for a resource, like list, create, retrieve, update, and delete actions, into one place. It helps organize code and reduces repetition.

beginner

How does a router work with ViewSets in Django REST Framework?

A router automatically creates URL patterns for all the actions in a ViewSet. It connects HTTP methods like GET or POST to the right ViewSet methods without writing URLs manually.

intermediate

What is the difference between a ModelViewSet and a regular ViewSet?

ModelViewSet provides default implementations for common actions (list, create, retrieve, update, destroy) based on a model. A regular ViewSet requires you to define these actions yourself.

beginner

Why use routers instead of manually defining URL patterns for ViewSets?

Routers save time and reduce errors by automatically generating all needed URLs for ViewSets. This keeps URL code clean and consistent.

beginner

How do you register a ViewSet with a router in Django REST Framework?

You create a router instance, then call its register() method with a URL prefix and the ViewSet class. Finally, include the router.urls in your URL configuration.

What does a router do in Django REST Framework?

A Handles database migrations

B Manages user authentication

C Automatically creates URL patterns for ViewSets

D Generates HTML templates

Routers automatically create URL patterns that connect HTTP requests to the correct ViewSet actions.

Which class provides default CRUD actions for a model in Django REST Framework?

A Serializer

B APIView

C GenericViewSet

D ModelViewSet

ModelViewSet includes default implementations for create, retrieve, update, delete, and list actions based on a model.

How do you connect a ViewSet to URLs using a router?

A router.register('prefix', ViewSetClass)

B urlpatterns.append(ViewSetClass)

C Include ViewSet in settings.py

D Add ViewSet to models.py

You register the ViewSet with a router using router.register() with a URL prefix and the ViewSet class.

Which HTTP method is typically used to update a resource in a ViewSet?

A PUT

B GET

C DELETE

D OPTIONS

PUT is used to update an existing resource in REST APIs, including ViewSets.

What is one benefit of using ViewSets?

A They replace the database

B They group related actions to reduce repeated code

C They automatically create HTML forms

D They handle user sessions

ViewSets group related actions like list, create, update, and delete to keep code organized and avoid repetition.

Explain how routers and ViewSets work together in Django REST Framework.

Think about how URLs and views connect in a REST API.

Describe the advantages of using ModelViewSet over a regular ViewSet.

Consider what common actions ModelViewSet handles for you.

Practice

1. What is the main purpose of using ViewSets in Django REST Framework?

easy

A. To group common web actions like list, create, update, and delete in one class

B. To define database models for the API

C. To write custom HTML templates for views

D. To handle user authentication manually

Solution

1. Step 1: Understand what ViewSets do

   ViewSets group common actions such as list, create, update, and delete into one class to simplify API views.

2. Step 2: Compare with other options

   Options B, C, and D describe unrelated tasks: models, templates, and authentication, which are not the main purpose of ViewSets.

3. Final Answer:

   To group common web actions like list, create, update, and delete in one class -> Option A

4. Quick Check:

   ViewSets group actions = A [OK]

Hint: ViewSets bundle common API actions together [OK]

Common Mistakes:

• Confusing ViewSets with models
• Thinking ViewSets handle templates
• Assuming ViewSets manage authentication

2. Which of the following is the correct way to register a ViewSet with a router in Django REST Framework?

easy

A. router.attach('items', ItemViewSet)

B. router.add('items', ItemViewSet)

C. router.register('items', ItemViewSet)

D. router.include('items', ItemViewSet)

Solution

1. Step 1: Recall the router method to register ViewSets

   The correct method to register a ViewSet with a router is register().

2. Step 2: Verify method names

   Methods like add(), include(), and attach() do not exist on routers for this purpose.

3. Final Answer:

   router.register('items', ItemViewSet) -> Option C

4. Quick Check:

   Use register() to add ViewSets to routers [OK]

Hint: Use router.register() to add ViewSets [OK]

Common Mistakes:

• Using non-existent router methods like add or include
• Confusing router registration with URL inclusion
• Forgetting to pass the ViewSet class

3. Given this code snippet, what URL patterns will be automatically created by the router?

from rest_framework import routers

router = routers.DefaultRouter()
router.register('books', BookViewSet)

medium

A. /books/list/ for list, /books/create/ for create

B. /books/viewset/ for all actions

C. /books/all/ for all actions

D. /books/ for list and create, /books/{pk}/ for retrieve, update, delete

Solution

1. Step 1: Understand DefaultRouter URL patterns

   DefaultRouter creates URLs like /books/ for listing and creating, and /books/{pk}/ for retrieve, update, and delete actions.

2. Step 2: Compare with other options

   Options A, C, and D use incorrect URL paths that are not generated by DefaultRouter automatically.

3. Final Answer:

   /books/ for list and create, /books/{pk}/ for retrieve, update, delete -> Option D

4. Quick Check:

   DefaultRouter creates standard REST URLs = B [OK]

Hint: DefaultRouter creates /resource/ and /resource/{id}/ URLs [OK]

Common Mistakes:

• Expecting custom URL suffixes like /list or /create
• Not knowing DefaultRouter auto-generates URLs
• Confusing URL patterns with manual URL configs

4. Identify the error in this router registration code:

from rest_framework import routers

router = routers.DefaultRouter()
router.register('authors', authorsViewSet)

medium

A. The ViewSet class name should be capitalized as AuthorsViewSet

B. The router should be SimpleRouter, not DefaultRouter

C. The register method requires a third argument for basename

D. The URL prefix 'authors' is invalid

Solution

1. Step 1: Check the ViewSet class name

   Python class names should be capitalized. 'authorsViewSet' is likely a typo and should be 'AuthorsViewSet'.

2. Step 2: Validate other options

   DefaultRouter is valid here, basename is optional if ViewSet has queryset, and 'authors' is a valid URL prefix.

3. Final Answer:

   The ViewSet class name should be capitalized as AuthorsViewSet -> Option A

4. Quick Check:

   Class names must be capitalized = A [OK]

Hint: Class names must start with uppercase letter [OK]

Common Mistakes:

• Using lowercase for class names
• Thinking basename is always required
• Confusing router types unnecessarily

5. You want to create a router that registers two ViewSets: ProductViewSet and CategoryViewSet. You also want to customize the basename for CategoryViewSet because it has no queryset attribute. Which code snippet correctly does this?

hard

A. router.register('products', ProductViewSet)
router.register('categories', CategoryViewSet)

B. router.register('products', ProductViewSet)
router.register('categories', CategoryViewSet, basename='category')

C. router.register('products', ProductViewSet, basename='product')
router.register('categories', CategoryViewSet)

D. router.register('products', ProductViewSet, basename='products')
router.register('categories', CategoryViewSet, basename=CategoryViewSet)

Solution

1. Step 1: Understand basename usage

   If a ViewSet lacks a queryset attribute, you must provide a basename when registering it with the router.

2. Step 2: Check the code snippets

   router.register('products', ProductViewSet) router.register('categories', CategoryViewSet, basename='category') correctly registers ProductViewSet without basename (assuming it has queryset) and CategoryViewSet with basename='category'. Other options either omit basename or misuse it.

3. Final Answer:

   router.register('products', ProductViewSet) router.register('categories', CategoryViewSet, basename='category') -> Option B

4. Quick Check:

   Provide basename if no queryset = C [OK]

Hint: Add basename if ViewSet has no queryset [OK]

Common Mistakes:

• Omitting basename for ViewSets without queryset
• Using wrong basename strings
• Adding basename unnecessarily