Testing API endpoints in Django - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the main purpose of testing API endpoints in Django?

To verify that the API responds correctly to requests, returns expected data, and handles errors properly.

beginner

Which Django tool is commonly used to test API endpoints?

Django REST Framework's APIClient, which simulates HTTP requests to test API views.

intermediate

What HTTP methods are typically tested in API endpoint tests?

GET, POST, PUT, PATCH, DELETE - to cover reading, creating, updating, and deleting data.

beginner

How do you check the response status code in a Django API test?

By asserting the response.status_code equals the expected HTTP status, like 200 for success.

intermediate

Why is it important to test both successful and failure cases in API endpoints?

To ensure the API handles valid requests correctly and gracefully manages errors or invalid input.

Which class is used to simulate API requests in Django REST Framework tests?

A RequestFactory

B HttpRequest

C APIClient

D TestCase

APIClient is designed to simulate HTTP requests for testing API endpoints in Django REST Framework.

What status code usually means a successful GET request?

A 201

B 500

C 404

D 200

Status code 200 means the request was successful and the server returned the requested data.

Which HTTP method is used to update part of a resource in an API?

A PATCH

B GET

C POST

D DELETE

PATCH is used to update part of a resource, unlike PUT which replaces the entire resource.

In Django API tests, how do you check the JSON response content?

A response.content.decode()

B response.json()

C response.text

D response.data

response.json() parses the response body as JSON, making it easy to check returned data.

Why should you test API endpoints with invalid data?

A To check error handling and validation

B To improve API speed

C To increase code coverage only

D To test database performance

Testing invalid data ensures the API properly validates input and returns helpful error messages.

Explain how to write a simple test for a GET API endpoint in Django REST Framework.

Think about simulating a request and checking the response.

Describe why testing both success and failure cases is important for API endpoints.

Consider what happens when users send good or bad requests.

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