Django / Django REST Framework (DRF)

Using API Views and ViewSets

This tutorial introduces API Views and ViewSets in Django REST Framework. We'll cover how they define the HTTP methods that can be utilized, and simplify the logic behind routing …

Tutorial 3 of 5 5 resources in this section

Section overview

5 resources

Introduces Django REST Framework (DRF) for building RESTful APIs with Django.

1. Introduction

The goal of this tutorial is to provide a comprehensive understanding of API Views and ViewSets in Django REST Framework. By the end of this tutorial, you will learn how to define HTTP methods using API Views and ViewSets, and how they simplify the logic behind routing and handling requests.

Prerequisites:
- Basic understanding of Python
- Familiarity with Django and Django REST Framework

2. Step-by-Step Guide

API Views and ViewSets are two important concepts in Django REST Framework. API Views determine the logic of how requests are handled. ViewSets, on the other hand, are just a type of class-based View, that do not provide any method handlers but are used for defining the view behavior.

API Views: An API View, is where you define the logic of your API. It determines how requests are handled. API Views are Python classes and can include methods to handle HTTP verbs like get, post, put, patch, delete.

ViewSets: A ViewSet is a simple, reusable class-based View, that does not provide any method handlers such as .get() or .post(), but provides actions such as .list(), .retrieve(), .create(), .update(), .partial_update(), and .destroy().

3. Code Examples

Example: API View

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

class HelloWorld(APIView):
    def get(self, request):
        return Response({"message": "Hello, World!"})

In this code snippet, we've created a simple APIView that handles GET requests. When a GET request is made, it returns a HTTP response with the message "Hello, World!".

Example: ViewSet

from rest_framework import viewsets
from rest_framework.response import Response

class HelloWorld(viewsets.ViewSet):
    def list(self, request):
        return Response({"message": "Hello, World!"})

In this example, we've created a simple ViewSet that handles the list action. When a GET request is made, it returns a HTTP response with the message "Hello, World!".

4. Summary

In this tutorial, we have learned about API Views and ViewSets in Django REST Framework. We have also seen how to use them to handle HTTP requests. Practice what you've learned with the exercises below.

For further learning, you can explore how to handle different types of HTTP requests with API Views and ViewSets, how to add authentication and permissions to your views, and how to use routers with ViewSets.

5. Practice Exercises

Exercise 1: Create an APIView that handles POST requests and returns the data sent in the request.

Exercise 2: Create a ViewSet that handles the create action and returns the data sent in the request.

Solutions:

Solution 1:

class Echo(APIView):
    def post(self, request):
        return Response({"received_data": request.data})

This APIView handles POST requests and simply echoes back the data sent in the request.

Solution 2:

class Echo(viewsets.ViewSet):
    def create(self, request):
        return Response({"received_data": request.data})

This ViewSet handles the create action and echoes back the data sent in the request.

Further Practice: Try handling other types of HTTP requests and actions. Try adding authentication and permissions to your views. Try using routers with ViewSets.

Need Help Implementing This?

We build custom systems, plugins, and scalable infrastructure.

Discuss Your Project

Related topics

Keep learning with adjacent tracks.

View category

HTML

Learn the fundamental building blocks of the web using HTML.

Explore

CSS

Master CSS to style and format web pages effectively.

Explore

JavaScript

Learn JavaScript to add interactivity and dynamic behavior to web pages.

Explore

Python

Explore Python for web development, data analysis, and automation.

Explore

SQL

Learn SQL to manage and query relational databases.

Explore

PHP

Master PHP to build dynamic and secure web applications.

Explore

Popular tools

Helpful utilities for quick tasks.

Browse tools

Percentage Calculator

Easily calculate percentages, discounts, and more.

Use tool

Favicon Generator

Create favicons from images.

Use tool

Time Zone Converter

Convert time between different time zones.

Use tool

Random Password Generator

Create secure, complex passwords with custom length and character options.

Use tool

Keyword Density Checker

Analyze keyword density for SEO optimization.

Use tool

Latest articles

Fresh insights from the CodiWiki team.

Visit blog

AI in Drug Discovery: Accelerating Medical Breakthroughs

In the rapidly evolving landscape of healthcare and pharmaceuticals, Artificial Intelligence (AI) in drug dis…

Read article

AI in Retail: Personalized Shopping and Inventory Management

In the rapidly evolving retail landscape, the integration of Artificial Intelligence (AI) is revolutionizing …

Read article

AI in Public Safety: Predictive Policing and Crime Prevention

In the realm of public safety, the integration of Artificial Intelligence (AI) stands as a beacon of innovati…

Read article

AI in Mental Health: Assisting with Therapy and Diagnostics

In the realm of mental health, the integration of Artificial Intelligence (AI) stands as a beacon of hope and…

Read article

AI in Legal Compliance: Ensuring Regulatory Adherence

In an era where technology continually reshapes the boundaries of industries, Artificial Intelligence (AI) in…

Read article

Need help implementing this?

Get senior engineering support to ship it cleanly and on time.

Get Implementation Help