Testing FastAPI Applications (Pytest + TestClient)

 

 Introduction

Writing APIs is great but how do you ensure they work correctly?That’s where testing comes in.

In this blog, you’ll learn:

  • How to test FastAPI APIs
  • Using pytest
  • Using FastAPI’s TestClient

Why Testing is Important?

Testing helps you:

  • Catch bugs early.
  • Ensure code reliability.
  • Prevent breaking changes.
  • Improve code quality.

Step 1: Install Testing Tools

pip install pytest httpx

Step 2: FastAPI TestClient

FastAPI provides a built-in client for testing APIs.

from fastapi.testclient import TestClient
from app.main import app

client = TestClient(app)

Project Structure for Testing
project/
├── app/
├── tests/
│   ├── test_main.py
Step 3: Write Your First Test
tests/test_main.py
def test_home():
    response = client.get("/")
    assert response.status_code == 200
    assert response.json() == {"message": "FastAPI project is running!"}

Step 4: Test POST Request
def test_create_item():
    response = client.post("/items/", json={
        "name": "Book",
        "description": "Education"
    })

    assert response.status_code == 200
    assert response.json()["name"] == "Book"
Step 5: Testing Protected Routes
def test_protected():
    token = "your_test_token"

    response = client.get(
        "/protected",
        headers={"Authorization": f"Bearer {token}"}
    )

    assert response.status_code in [200, 401]

Step 6: Run Tests
pytest
Output:
==== test session starts ====
collected 3 items

test_main.py ...

Using Fixtures (Advanced)
Fixtures help reuse setup code.
import pytest

@pytest.fixture
def sample_data():
    return {"name": "Test", "description": "Sample"}

def test_with_fixture(sample_data):
    response = client.post("/items/", json=sample_data)
    assert response.status_code == 200

Testing Database (Optional)
For DB testing:
  • Use test database

  • Use rollback after tests

Common Mistakes
Not testing edge cases
Using real database instead of test DB
Hardcoding values
Ignoring failed tests
Best Practices
Write tests for all endpoints
Keep tests simple & readable
Use fixtures for reuse
Automate tests (CI/CD)

Key Takeaways
  • FastAPI provides built-in testing tools

  • pytest is simple and powerful
  • Always test APIs before deployment

  • Good tests = reliable applications

Comments

Post a Comment

Popular posts from this blog

Database Integration in FastAPI (SQLAlchemy CRUD)

  Introduction So far, we’ve built APIs without storing data.But real-world applications need a database to: Store user data. Manage products. Persist application state. In this blog, we’ll connect FastAPI with a database using SQLAlchemy and perform CRUD operations . What is SQLAlchemy? SQLAlchemy is a powerful Python ORM (Object Relational Mapper) that allows you to: Interact with databases using Python code. Avoid writing raw SQL queries. Work with models instead of tables. Step 1: Install Dependencies pip install sqlalchemy (For SQLite, no extra driver needed) Project Structure Update app/ ├── main.py ├── database/ │ ├── connection.py ├── models/ │ ├── item.py ├── schemas/ │ ├── item.py ├── routes/ │ ├── item.py Step 2: Database Connection app/database/connection.py from sqlalchemy import create_engine from sqlalchemy . orm import sessionmaker , declarative_base DATABASE_URL = "sqlite:///./test.db" engine = create_engine ( DAT...
Read more

Middleware & CORS in FastAPI

  Introduction As your API grows, you may need to: Log requests Modify responses Handle cross-origin requests This is where Middleware and CORS (Cross-Origin Resource Sharing) come into play.They help control how requests and responses flow through your application. What is Middleware? Middleware is a function that runs: Before a request reaches your route After a response is returned Think of it as a pipeline layer between client and server. Request Flow with Middleware Client → Middleware → Route → Middleware → Response Creating Custom Middleware from fastapi import FastAPI , Request import time app = FastAPI () @ app . middleware ( "http" ) async def log_requests ( request : Request , call_next ): start_time = time . time() response = await call_next ( request ) process_time = time . time() - start_time print ( f"Request: { request . url} | Time: { process_time } " ) return response What This Middle...
Read more

Python Data Handling

Python Data Handling for Beginners In Python, data handling means storing, changing, and using data in different ways. In this post, you will learn: Lists Tuples Dictionaries Sets String Methods Type Conversion 1. Python Lists :Lists store many values in one variable.                fruits = ["apple", "banana", "mango"]                                                                       Method                          Use                                            append()          ...
Read more