Testing path operations in FastAPI

Introduction

Testing path operations helps ensure your web API works correctly. It checks if your routes respond as expected.

You want to confirm your API returns the right data for a request.

You need to check that error handling works when bad input is sent.

You want to automate tests to catch bugs early during development.

You are adding new features and want to verify existing routes still work.

Syntax

FastAPI

from fastapi.testclient import TestClient

client = TestClient(app)

response = client.get('/path')
assert response.status_code == 200
assert response.json() == expected_data

Use TestClient from FastAPI to simulate requests without running a server.

Check response.status_code and response.json() to verify output.

Examples

Test a GET request to fetch item with ID 1 and check the returned JSON.

FastAPI

response = client.get('/items/1')
assert response.status_code == 200
assert response.json() == {'item_id': 1, 'name': 'Item One'}

Test a POST request to create a new item and verify the response includes an ID.

FastAPI

response = client.post('/items/', json={'name': 'New Item'})
assert response.status_code == 201
assert 'id' in response.json()

Test a GET request for a missing item and expect a 404 Not Found status.

FastAPI

response = client.get('/items/999')
assert response.status_code == 404

Sample Program

This example shows a simple FastAPI app with two tests. One test checks a valid item returns correct data. The other test checks a missing item returns a 404 error. Running the script prints confirmation if tests pass.

FastAPI

from fastapi import FastAPI, HTTPException
from fastapi.testclient import TestClient

app = FastAPI()

items = {1: {'name': 'Item One'}, 2: {'name': 'Item Two'}}

@app.get('/items/{item_id}')
async def read_item(item_id: int):
    if item_id in items:
        return {'item_id': item_id, 'name': items[item_id]['name']}
    raise HTTPException(status_code=404, detail='Item not found')

client = TestClient(app)

def test_read_existing_item():
    response = client.get('/items/1')
    assert response.status_code == 200
    assert response.json() == {'item_id': 1, 'name': 'Item One'}

def test_read_missing_item():
    response = client.get('/items/999')
    assert response.status_code == 404
    assert response.json() == {'detail': 'Item not found'}

# Run tests
if __name__ == '__main__':
    test_read_existing_item()
    test_read_missing_item()
    print('All tests passed!')

Important Notes

Tests run quickly without starting a real server using TestClient.

Always check both status code and response content for full verification.

Use descriptive test function names to keep tests clear and organized.

Summary

Testing path operations ensures your API routes work as expected.

Use FastAPI's TestClient to simulate requests easily.

Check response status and data to confirm correct behavior.