Testing API endpoints in Django - Step-by-Step Execution

Concept Flow - Testing API endpoints

Write test case class

↓

Setup test client and data

↓

Send HTTP request to API endpoint

↓

Receive response

↓

Check response status and data

↓

Pass or fail test

This flow shows how a test case sends a request to an API endpoint and checks the response to confirm correct behavior.

Execution Sample

Django

from django.test import TestCase, Client

class MyApiTest(TestCase):
    def test_get_items(self):
        client = Client()
        response = client.get('/api/items/')
        self.assertEqual(response.status_code, 200)

This code tests a GET request to '/api/items/' and checks if the response status code is 200 (OK).

Execution Table

Step	Action	Input/Request	Response Status	Response Data	Test Assertion
1	Create test client	None	N/A	N/A	N/A
2	Send GET request	GET /api/items/	200	[{"id":1, "name":"Item1"}, {"id":2, "name":"Item2"}]	Check status_code == 200
3	Assert response status	200	200	N/A	Pass if status_code is 200
4	Assert response data	N/A	200	[{"id":1, "name":"Item1"}, {"id":2, "name":"Item2"}]	Pass if data matches expected
5	Test ends	N/A	N/A	N/A	Test passes if all assertions succeed

💡 Test ends after all assertions pass or fail

Variable Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	Final
client	None	Client instance	Client instance	Client instance	Client instance
response	None	None	HttpResponse with status 200 and data	HttpResponse with status 200 and data	HttpResponse with status 200 and data

Key Moments - 3 Insights

Why do we create a test client before sending requests?

The test client simulates a browser or API consumer. It allows sending HTTP requests in tests without running a real server. See Step 1 in execution_table.

What does checking response.status_code == 200 mean?

It means the API responded successfully. Status code 200 means OK. This is shown in Step 3 where the test asserts the response status.

How do we verify the API returns the correct data?

By comparing response data to expected data in Step 4. If they match, the test passes, confirming the API returns correct content.

Visual Quiz - 3 Questions

Look at the execution table, what is the response status after sending the GET request?

A 404

B 200

C 500

D 302

💡 Hint

Check Step 2 in the execution_table under Response Status

At which step does the test check if the response status code is 200?

A Step 3

B Step 4

C Step 1

D Step 5

💡 Hint

Look at the Test Assertion column in execution_table

If the API returned status 404 instead of 200, what would happen in the test?

A Test would pass

B Test would fail at Step 4

C Test would fail at Step 3

D Test would continue without error

💡 Hint

Refer to Step 3 where status_code is asserted to be 200

Concept Snapshot

Testing API endpoints in Django:
- Use django.test.Client to simulate requests
- Send HTTP methods (GET, POST, etc.) to API URLs
- Check response.status_code for success (200)
- Verify response data matches expected
- Assertions confirm test pass or fail

Full Transcript

Testing API endpoints in Django involves writing test case classes that use the test client to send HTTP requests to API URLs. The client simulates a user or app calling the API. After sending a request, the test receives a response object. The test checks the response status code to ensure the API responded successfully, usually expecting 200 for OK. It also verifies the response data matches what is expected. If all assertions pass, the test passes. This process helps confirm the API works correctly without needing a live server.

Practice

1. What is the main purpose of using Django REST Framework's APIClient in testing?

easy

A. To simulate API requests and check responses

B. To create database migrations automatically

C. To generate HTML templates for views

D. To manage user authentication in the admin panel

Solution

1. Step 1: Understand the role of APIClient

   APIClient is designed to simulate HTTP requests to API endpoints in tests.

2. Step 2: Identify its testing purpose

   It helps verify that the API sends correct responses to requests.

3. Final Answer:

   To simulate API requests and check responses -> Option A

4. Quick Check:

   APIClient simulates API calls [OK]

Hint: APIClient is for simulating API calls in tests [OK]

Common Mistakes:

• Confusing APIClient with database migration tools
• Thinking APIClient generates HTML templates
• Assuming APIClient manages admin authentication

2. Which of the following is the correct way to import APIClient for testing in Django REST Framework?

easy

A. from django.test import APIClient

B. from rest_framework.test import APIClient

C. import APIClient from rest_framework

D. from rest_framework.client import APIClient

Solution

1. Step 1: Recall the correct import path

   APIClient is part of rest_framework.test module.

2. Step 2: Match the correct syntax

   The correct import is from rest_framework.test import APIClient.

3. Final Answer:

   from rest_framework.test import APIClient -> Option B

4. Quick Check:

   Correct import path [OK]

Hint: APIClient is in rest_framework.test module [OK]

Common Mistakes:

• Importing APIClient from django.test instead
• Using incorrect import syntax like 'import APIClient from ...'
• Confusing module rest_framework.client with rest_framework.test

3. Given the following test code snippet, what will be the status code of the response if the endpoint exists and returns data successfully?

client = APIClient()
response = client.get('/api/items/')
print(response.status_code)

medium

A. 404

B. 302

C. 200

D. 500

Solution

1. Step 1: Understand the GET request behavior

   A successful GET request to an existing API endpoint returns status code 200.

2. Step 2: Identify the expected status code

   Since the endpoint exists and returns data, the status code will be 200.

3. Final Answer:

   200 -> Option C

4. Quick Check:

   Successful GET response = 200 [OK]

Hint: Successful GET requests return 200 status code [OK]

Common Mistakes:

• Confusing 404 (not found) with success
• Assuming 500 means success
• Thinking 302 redirect is default for API GET

4. Identify the error in this test code snippet that causes the test to fail:

client = APIClient()
response = client.post('/api/items/', data={'name': 'Book'})
self.assertEqual(response.status_code, 201)

medium

A. Missing format='json' in the post request

B. Using post instead of get for data retrieval

C. Incorrect URL path format

D. Not importing APIClient before use

Solution

1. Step 1: Check POST request data format

   By default, APIClient sends data as form-encoded unless format='json' is specified.

2. Step 2: Understand why test fails

   The API expects JSON data, so missing format='json' causes the server to reject or misinterpret data, failing the test.

3. Final Answer:

   Missing format='json' in the post request -> Option A

4. Quick Check:

   POST JSON data needs format='json' [OK]

Hint: Add format='json' when posting JSON data [OK]

Common Mistakes:

• Assuming POST sends JSON by default
• Confusing GET and POST methods
• Ignoring import statements

5. You want to test an API endpoint that requires authentication. Which sequence correctly tests a protected GET endpoint using Django REST Framework's APIClient?

hard

A. Call client.get() first, then authenticate client with credentials

B. Set authentication headers manually without using client methods

C. Use client.post() without authentication to access the endpoint

D. Authenticate client with credentials, then call client.get() on the endpoint

Solution

1. Step 1: Authenticate the APIClient before requests

   Use client.force_authenticate(user=user) or set credentials before making requests.

2. Step 2: Make the GET request after authentication

   Once authenticated, call client.get() to access the protected endpoint successfully.

3. Final Answer:

   Authenticate client with credentials, then call client.get() on the endpoint -> Option D

4. Quick Check:

   Authenticate before GET request [OK]

Hint: Authenticate client before calling protected endpoint [OK]

Common Mistakes:

• Calling GET before authentication
• Using POST instead of GET for retrieval
• Manually setting headers incorrectly