Testing API endpoints in Django - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to import the Django test client.

Django

from django.test import [1]

Drag options to blanks, or click blank then click option'

ARequestFactory

BTestCase

CClient

DSimpleTestCase

Attempts:

3 left

💡 Hint

Common Mistakes

Importing TestCase instead of Client

Using RequestFactory which is different from Client

Forgetting to import anything

The Django test client is imported from django.test as Client. It allows you to simulate requests to your API endpoints.

2fill in blank

medium

Complete the code to send a GET request to the '/api/items/' endpoint using the test client.

Django

client = Client()
response = client.[1]('/api/items/')

Drag options to blanks, or click blank then click option'

Apost

Bget

Cput

Ddelete

Attempts:

3 left

💡 Hint

Common Mistakes

Using post instead of get for retrieving data

Using put or delete which modify data

Calling a method that does not exist on Client

The get method sends a GET request to the specified URL. This is used to retrieve data from the API endpoint.

3fill in blank

hard

Fix the error in the assertion to check if the response status code is 200.

Django

self.assertEqual(response.status_code, [1])

Drag options to blanks, or click blank then click option'

A200

B404

C500

D201

Attempts:

3 left

💡 Hint

Common Mistakes

Using 201 which means created

Using 404 which means not found

Using 500 which means server error

The HTTP status code 200 means the request was successful. This is the expected status code for a successful GET request.

4fill in blank

hard

Fill both blanks to send a POST request with JSON data to '/api/items/'.

Django

response = client.post('/api/items/', [1], content_type=[2])

Drag options to blanks, or click blank then click option'

A{'name': 'item1'}

B'application/json'

C'text/html'

D{'id': 1}

Attempts:

3 left

💡 Hint

Common Mistakes

Passing data as a string instead of a dictionary

Using wrong content type like 'text/html'

Not setting content_type at all

When sending JSON data in a POST request, you pass a dictionary as data and set content_type to 'application/json' so the server knows the data format.

5fill in blank

hard

Fill all three blanks to check if the response JSON contains the expected 'name' field.

Django

data = response.json()
self.assertEqual(data.get([1]), [2])
self.assertTrue([3] in data)

Drag options to blanks, or click blank then click option'

A'name'

B'item1'

D'id'

Attempts:

3 left

💡 Hint

Common Mistakes

Using wrong keys like 'id'

Checking for keys that don't exist

Mixing up keys and values

We check that the JSON response has a key 'name' with value 'item1'. Also, we verify that the key 'name' exists in the data.

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