Testing API endpoints in Django - Practice Problems & Coding Challenges

Challenge - 5 Problems

❓ component_behavior

intermediate

What is the response status code for a successful GET request in Django REST Framework test?

Consider a Django REST Framework API endpoint tested with APIClient's get method. What status code should you expect for a successful GET request?

Django

from rest_framework.test import APIClient
client = APIClient()
response = client.get('/api/items/')

A 200

B 201

C 404

D 400

💡 Hint

A successful GET request usually returns a status code indicating success without creating new resources.

A successful GET request returns HTTP status code 200, meaning OK. Codes like 201 indicate resource creation, 400 is a bad request, and 404 means not found.

❓ state_output

intermediate

What is the value of response.data after posting valid data?

Given a Django REST Framework API test that posts valid data to create a new item, what will response.data contain?

Django

from rest_framework.test import APIClient
client = APIClient()
data = {'name': 'Test Item', 'price': 10.5}
response = client.post('/api/items/', data, format='json')

A {'error': 'Invalid data'}

B {'name': 'Test Item', 'price': 10.5}

C None

D {'id': 1, 'name': 'Test Item', 'price': 10.5}

💡 Hint

When a new item is created, the response usually includes the new item's ID along with the data sent.

After a successful POST, the response data includes the created item's fields plus its generated ID.

📝 Syntax

advanced

Which option correctly imports and uses APIClient in Django REST Framework tests?

Select the option that correctly imports APIClient and uses it to make a GET request in a Django test.

A

import APIClient from rest_framework.test
client = APIClient()
response = client.get('/api/data/')

B

from django.test import APIClient
client = APIClient()
response = client.get('/api/data/')

C

from rest_framework.test import APIClient
client = APIClient()
response = client.get('/api/data/')

D

from rest_framework.test import APIClient
client = APIClient
response = client.get('/api/data/')

💡 Hint

Check the correct import path and usage syntax for APIClient.

APIClient must be imported from rest_framework.test and instantiated with parentheses. Option C imports from wrong module, C has wrong import syntax, D forgets parentheses when instantiating.

🔧 Debug

advanced

Why does this test raise an AssertionError when checking response status?

This test expects status code 201 but fails. Why? from rest_framework.test import APIClient client = APIClient() data = {'title': 'New Post'} response = client.post('/api/posts/', data) assert response.status_code == 201

Django

from rest_framework.test import APIClient
client = APIClient()
data = {'title': 'New Post'}
response = client.post('/api/posts/', data)
assert response.status_code == 201

A The URL '/api/posts/' is incorrect and causes a 404 error.

B The post method needs format='json' to send JSON data; without it, the server rejects the data causing a 400 error.

C The data dictionary is missing required fields causing a 500 server error.

D The APIClient instance was not created properly causing a TypeError.

💡 Hint

Check how data is sent in POST requests with APIClient.

Without specifying format='json', APIClient sends data as form-encoded, which the API may reject, returning 400 instead of 201.

🧠 Conceptual

expert

Which option best describes the purpose of force_authenticate in DRF APIClient tests?

In Django REST Framework tests, what does the method force_authenticate do when used with APIClient?

A It forcibly sets the user on the client to simulate an authenticated request without performing actual login.

B It logs in the user by checking credentials against the database.

C It disables authentication checks for all requests made by the client.

D It resets the client's session to an anonymous user.

💡 Hint

Think about how tests simulate logged-in users without real login.

force_authenticate sets the user directly on the client to simulate authentication, bypassing login and token checks.

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