TestClient basics in FastAPI - Step-by-Step Execution

Concept Flow - TestClient basics

Create FastAPI app

↓

Import TestClient

↓

Initialize TestClient with app

↓

Make HTTP request (GET/POST/etc)

↓

Receive response object

↓

Check response status and data

↓

Assert expected results

↓

Test ends

This flow shows how to create a FastAPI app, use TestClient to send requests, get responses, and check results.

Execution Sample

FastAPI

from fastapi import FastAPI
from fastapi.testclient import TestClient

app = FastAPI()

@app.get("/")
def read_root():
    return {"Hello": "World"}

client = TestClient(app)
response = client.get("/")
print(response.status_code, response.json())

This code creates a FastAPI app with a root GET endpoint, then uses TestClient to send a GET request and prints the status and JSON response.

Execution Table

Step	Action	Input/Request	Response Status	Response JSON	Notes
1	Create FastAPI app	N/A	N/A	N/A	App instance created
2	Define GET / endpoint	N/A	N/A	N/A	Returns {"Hello": "World"}
3	Initialize TestClient	App instance	N/A	N/A	Client ready to send requests
4	Send GET request to /	GET /	200	{"Hello": "World"}	Request sent, response received
5	Print response	N/A	200	{"Hello": "World"}	Output: 200 {'Hello': 'World'}
6	End	N/A	N/A	N/A	Test complete

💡 Test ends after receiving and printing the response from GET /

Variable Tracker

Variable	Start	After Step 1	After Step 3	After Step 4	Final
app	undefined	FastAPI instance	FastAPI instance	FastAPI instance	FastAPI instance
client	undefined	undefined	TestClient instance	TestClient instance	TestClient instance
response	undefined	undefined	undefined	Response object (status 200, JSON)	Response object (status 200, JSON)

Key Moments - 3 Insights

Why do we pass the FastAPI app instance to TestClient?

TestClient needs the app instance to know which app to send requests to, as shown in step 3 of the execution_table.

What does response.status_code represent?

It shows the HTTP status code returned by the app for the request, for example 200 means success, as seen in step 4.

Why do we call response.json()?

response.json() parses the response body as JSON so we can check the data returned by the app, demonstrated in step 4 and 5.

Visual Quiz - 3 Questions

Look at the execution_table, what is the response status code after sending GET /?

A 404

B 200

C 500

D 301

💡 Hint

Check the Response Status column at Step 4 in the execution_table.

At which step is the TestClient instance created?

A Step 1

B Step 2

C Step 3

D Step 4

💡 Hint

Look at the Action column in the execution_table for when TestClient is initialized.

If the GET / endpoint returned a 404, how would the response.status_code change in the table?

A It would show 404 at Step 4

B It would show 200 at Step 4

C It would show 500 at Step 4

D It would not change

💡 Hint

Response Status column at Step 4 shows the actual HTTP status code returned.

Concept Snapshot

TestClient basics in FastAPI:
- Import TestClient and create FastAPI app
- Initialize TestClient with app instance
- Use client.get/post to send requests
- Receive response object with status_code and json()
- Assert response data to test endpoints
- Helps test API without running server

Full Transcript

This lesson shows how to use FastAPI's TestClient to test API endpoints. First, we create a FastAPI app and define a GET endpoint at root that returns a JSON message. Then, we import TestClient and initialize it with the app instance. Using the client, we send a GET request to the root path. The client returns a response object containing the HTTP status code and JSON data. We print these to verify the endpoint works as expected. This process lets us test API behavior quickly without starting a real server.

Practice

1. What is the main purpose of FastAPI's TestClient?

easy

A. To test FastAPI applications without running a real server

B. To deploy FastAPI applications to production

C. To generate API documentation automatically

D. To create database migrations for FastAPI apps

Solution

1. Step 1: Understand what TestClient does

   TestClient simulates HTTP requests to your FastAPI app internally without needing a real server.

2. Step 2: Compare options with TestClient's purpose

   Only To test FastAPI applications without running a real server describes testing without a real server, which matches TestClient's role.

3. Final Answer:

   To test FastAPI applications without running a real server -> Option A

4. Quick Check:

   TestClient purpose = testing without server [OK]

Hint: TestClient runs tests without starting a real server [OK]

Common Mistakes:

• Confusing TestClient with deployment tools
• Thinking TestClient generates docs
• Assuming TestClient manages databases

2. Which of the following is the correct way to import and create a TestClient instance for a FastAPI app named app?

easy

A. from fastapi import TestClient
client = TestClient(app)

B. from fastapi.testclient import Client
client = Client(app)

C. import TestClient from fastapi
client = TestClient(app)

D. from fastapi.testclient import TestClient
client = TestClient(app)

Solution

1. Step 1: Recall correct import path

   The TestClient is imported from fastapi.testclient, not directly from fastapi or other names.

2. Step 2: Check instantiation syntax

   TestClient is instantiated by passing the FastAPI app object as an argument.

3. Final Answer:

   from fastapi.testclient import TestClient\nclient = TestClient(app) -> Option D

4. Quick Check:

   Correct import and instantiation = from fastapi.testclient import TestClient client = TestClient(app) [OK]

Hint: Import TestClient from fastapi.testclient exactly [OK]

Common Mistakes:

• Importing TestClient directly from fastapi
• Using wrong class name like Client
• Incorrect import syntax

3. Given this FastAPI app and test code, what will response.status_code be?

from fastapi import FastAPI
from fastapi.testclient import TestClient

app = FastAPI()

@app.get("/hello")
def hello():
    return {"message": "Hi"}

client = TestClient(app)
response = client.get("/hello")
print(response.status_code)

medium

A. 404

B. 403

C. 200

D. 500

Solution

1. Step 1: Check route definition

   The app defines a GET route at "/hello" that returns a JSON message with status 200 by default.

2. Step 2: Analyze the test client request

   The client sends a GET request to "/hello", which matches the route, so the response status code is 200.

3. Final Answer:

   200 -> Option C

4. Quick Check:

   GET /hello returns 200 status [OK]

Hint: Matching route returns 200 status by default [OK]

Common Mistakes:

• Assuming 404 because of missing route
• Thinking 500 due to server error
• Confusing status codes

4. What is wrong with this test code using TestClient?

from fastapi import FastAPI
from fastapi.testclient import TestClient

app = FastAPI()

@app.get("/items/{item_id}")
def read_item(item_id: int):
    return {"item_id": item_id}

client = TestClient(app)
response = client.get("/items/item1")
print(response.status_code)

medium

A. The route path parameter expects an int, but 'item1' is a string

B. TestClient is not imported correctly

C. The route decorator is missing parentheses

D. The app instance is not created

Solution

1. Step 1: Check route parameter type

   The route expects an integer item_id but the test sends 'item1' which is a string.

2. Step 2: Understand FastAPI's type validation

   FastAPI will reject the request with a 422 error because 'item1' cannot be converted to int.

3. Final Answer:

   The route path parameter expects an int, but 'item1' is a string -> Option A

4. Quick Check:

   Type mismatch in path parameter causes error [OK]

Hint: Match path parameter types exactly in test URLs [OK]

Common Mistakes:

• Ignoring type mismatch in path parameters
• Assuming string works for int parameters
• Overlooking FastAPI validation errors

5. You want to test a POST endpoint /users/ that expects JSON data {"name": "Alice"}. Which TestClient call correctly sends this data and checks for a 201 status code?

from fastapi import FastAPI
from fastapi.testclient import TestClient

app = FastAPI()

@app.post("/users/")
def create_user(user: dict):
    return user, 201

client = TestClient(app)
# Which call is correct?

hard

A. response = client.get("/users/", json={"name": "Alice"})
assert response.status_code == 201

B. response = client.post("/users/", json={"name": "Alice"})
assert response.status_code == 201

C. response = client.post("/users/", data="{'name': 'Alice'}")
assert response.status_code == 201

D. response = client.post("/users/", params={"name": "Alice"})
assert response.status_code == 201

Solution

1. Step 1: Identify correct HTTP method and data format

   The endpoint expects a POST request with JSON data. Using json= sends JSON correctly.

2. Step 2: Check status code assertion

   The endpoint returns status 201 on success, so asserting response.status_code == 201 is correct.

3. Final Answer:

   response = client.post("/users/", json={"name": "Alice"})\nassert response.status_code == 201 -> Option B

4. Quick Check:

   POST with json= and check 201 status [OK]

Hint: Use json= for POST JSON data, not data= or params= [OK]

Common Mistakes:

• Using GET instead of POST
• Sending data as string instead of JSON
• Using params instead of JSON body