APIView for custom endpoints in Django - Step-by-Step Execution

Concept Flow - APIView for custom endpoints

Client sends HTTP request

↓

APIView receives request

↓

Dispatch method checks HTTP method

↓

get()

↓

Process request logic

↓

Return HTTP response with data

The APIView receives an HTTP request, checks its method, calls the matching handler method, processes logic, and returns a response.

Execution Sample

Django

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

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

Defines a simple APIView that responds with a JSON message when a GET request is made.

Execution Table

Step	Action	HTTP Method	Handler Called	Response Content
1	Receive request	GET	Dispatch method	None yet
2	Dispatch checks method	GET	get()	None yet
3	Execute get()	GET	get()	{"message": "Hello, world!"}
4	Return response	GET	get()	{"message": "Hello, world!"}
5	Request complete	GET	None	Response sent to client

💡 Request handled by get() method, response returned, execution ends.

Variable Tracker

Variable	Start	After Step 2	After Step 3	Final
request.method	None	GET	GET	GET
handler	None	get	get	get
response.data	None	None	{"message": "Hello, world!"}	{"message": "Hello, world!"}

Key Moments - 3 Insights

How does APIView know which method (get, post, etc.) to call?

The dispatch method checks the HTTP method of the request and calls the matching handler like get() or post(). See execution_table step 2.

What happens if the HTTP method is not defined in the APIView?

APIView returns a 405 Method Not Allowed error automatically because no handler method matches. This is implicit in dispatch behavior.

Why do we return Response({"message": "Hello, world!"}) instead of a plain dictionary?

Response wraps the data and sets proper content type and status code for HTTP response. See execution_table step 3 where Response is created.

Visual Quiz - 3 Questions

Look at the execution table, which handler method is called for a GET request?

A put()

B post()

C get()

D delete()

💡 Hint

Check the 'Handler Called' column at step 2 and 3 in the execution_table.

At which step is the response data created?

A Step 3

B Step 1

C Step 2

D Step 5

💡 Hint

Look at the 'Response Content' column in execution_table to see when data appears.

If you add a post() method, what changes in the execution flow for a POST request?

A Response is returned without calling any handler

B Dispatch calls post() instead of get()

C Dispatch still calls get()

D Request is ignored

💡 Hint

Recall dispatch chooses handler based on HTTP method, see concept_flow diagram.

Concept Snapshot

APIView handles HTTP requests by matching methods like get(), post(), etc.
Dispatch method routes requests to these handlers.
Handlers return Response objects with data.
If method not defined, 405 error is returned.
Use APIView for custom endpoint logic in Django REST Framework.

Full Transcript

An APIView in Django REST Framework receives HTTP requests and uses its dispatch method to check the request's HTTP method. It then calls the matching handler method such as get() for GET requests. The handler processes the request and returns a Response object containing data. If the HTTP method is not implemented, APIView returns a 405 Method Not Allowed error. This flow ensures custom endpoints can handle different HTTP methods cleanly and return proper HTTP responses.

Practice

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

easy

A. To automatically generate database tables.

B. To manage user authentication without coding.

C. To style HTML templates.

D. To create custom endpoints by defining methods like get() and post().

Solution

1. Step 1: Understand the role of APIView

   APIView allows you to write custom logic for handling HTTP requests by defining methods like get() and post().

2. Step 2: Compare other options

   Options A, C, and D describe unrelated tasks like database management, styling, or authentication without coding, which APIView does not do automatically.

3. Final Answer:

   To create custom endpoints by defining methods like get() and post(). -> Option D

4. Quick Check:

   APIView = custom HTTP methods [OK]

Hint: APIView is for custom HTTP methods like get/post [OK]

Common Mistakes:

• Thinking APIView auto-generates database tables
• Confusing APIView with template rendering
• Assuming APIView manages authentication alone

2. Which of the following is the correct way to import APIView and Response in a Django REST Framework view?

easy

A. from django.views import APIView
from django.http import Response

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

C. import APIView from rest_framework
import Response from rest_framework

D. from rest_framework.api import APIView
from rest_framework.api import Response

Solution

1. Step 1: Recall correct import paths

   APIView is imported from rest_framework.views and Response from rest_framework.response.

2. Step 2: Check other options for errors

   from django.views import APIView from django.http import Response uses django.views and django.http which do not provide APIView or DRF Response. import APIView from rest_framework import Response from rest_framework uses invalid import syntax. from rest_framework.api import APIView from rest_framework.api import Response uses wrong module paths.

3. Final Answer:

   from rest_framework.views import APIView from rest_framework.response import Response -> Option B

4. Quick Check:

   Correct import paths = from rest_framework.views import APIView from rest_framework.response import Response [OK]

Hint: APIView from views, Response from response module [OK]

Common Mistakes:

• Importing APIView from django.views
• Using incorrect import syntax
• Importing Response from wrong module

3. Given this APIView code, what will be the HTTP status code in the response?

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

class HelloView(APIView):
    def get(self, request):
        return Response({"message": "Hello!"}, status=201)

medium

A. 201 Created

B. 404 Not Found

C. 200 OK

D. 500 Internal Server Error

Solution

1. Step 1: Identify the status code in Response

   The Response is returned with status=201, which means Created.

2. Step 2: Match status code to HTTP meaning

   201 means resource created successfully, so the response status will be 201 Created.

3. Final Answer:

   201 Created -> Option A

4. Quick Check:

   Status=201 means Created [OK]

Hint: Check status argument in Response call [OK]

Common Mistakes:

• Assuming default 200 OK without checking status
• Confusing 201 with 404 or 500
• Ignoring the status parameter in Response

4. Identify the error in this APIView code snippet:

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

class MyView(APIView):
    def post(self, request):
        data = request.data
        return Response(data, status=200)

    def get(self):
        return Response({"msg": "Hello"})

medium

A. The get method is missing the request parameter.

B. The post method should not return a Response.

C. The status code 200 is invalid in Response.

D. request.data is not accessible in APIView.

Solution

1. Step 1: Check method signatures

   In APIView, all HTTP methods must accept self and request parameters. The get method lacks the request parameter.

2. Step 2: Validate other statements

   Returning Response in post is correct. Status 200 is valid. request.data is accessible in APIView.

3. Final Answer:

   The get method is missing the request parameter. -> Option A

4. Quick Check:

   All HTTP methods need request parameter [OK]

Hint: Check method parameters: self and request required [OK]

Common Mistakes:

• Omitting request parameter in methods
• Thinking status=200 is invalid
• Believing request.data is unavailable

5. You want to create a custom APIView that accepts a POST request with JSON data containing a number, doubles it, and returns the result with status 200. Which code snippet correctly implements this?

hard

A. class DoubleView(APIView):
def get(self, request):
num = request.data.get('number')
result = num * 2
return Response({'result': result}, status=200)

B. class DoubleView(APIView):
def post(self, request):
num = request.data['number']
result = num + num
return Response({'result': result}, status=201)

C. class DoubleView(APIView):
def post(self, request):
num = request.data.get('number')
result = num * 2
return Response({'result': result}, status=200)

D. class DoubleView(APIView):
def post(self):
num = request.data.get('number')
result = num * 2
return Response({'result': result}, status=200)

Solution

1. Step 1: Check method and parameters

   POST method must be defined with self and request parameters. class DoubleView(APIView): def post(self, request): num = request.data.get('number') result = num * 2 return Response({'result': result}, status=200) correctly defines post(self, request).

2. Step 2: Validate data access and response

   class DoubleView(APIView): def post(self, request): num = request.data.get('number') result = num * 2 return Response({'result': result}, status=200) safely uses request.data.get('number') and multiplies by 2. It returns Response with status=200 as required.

3. Step 3: Review other options

   class DoubleView(APIView): def post(self, request): num = request.data['number'] result = num + num return Response({'result': result}, status=201) uses status=201 (wrong status). class DoubleView(APIView): def get(self, request): num = request.data.get('number') result = num * 2 return Response({'result': result}, status=200) uses get method instead of post. class DoubleView(APIView): def post(self): num = request.data.get('number') result = num * 2 return Response({'result': result}, status=200) misses request parameter in post method.

4. Final Answer:

   class DoubleView(APIView): def post(self, request): num = request.data.get('number') result = num * 2 return Response({'result': result}, status=200) -> Option C

5. Quick Check:

   POST with request param, multiply, status=200 [OK]

Hint: POST method with request param, multiply, return status 200 [OK]

Common Mistakes:

• Using get method instead of post
• Missing request parameter in method
• Returning wrong status code
• Accessing request.data incorrectly