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.