FastAPI-Tests

FastAPI basiert auf StarletteTestClientBietet praktische Testunterstützung, sodass Sie API-Anfragen und -Antworten testen können, ohne einen Server zu starten.


Abhängigkeiten installieren

TestClientbasiert aufhttpx, müssen Sie Folgendes installieren:

pip install httpx

Einfacher Test

NutzungTestClientErstellen Sie einen Testclient und verwenden Sie ihn wiehttpxsenden Sie die Anfrage auf die gleiche Weise:

Beispiel

from fastapi import FastAPI
from fastapi.testclient import TestClient

app = FastAPI()


@app.get("/")
async def root():
    return {"message": "Hello World"}


# Testclient erstellen
client = TestClient(app)


# Testfunktion
def test_root():
    response = client.get("/")
    assert response.status_code == 200
    assert response.json() == {"message": "Hello World"}

TestClientRuft die FastAPI-Anwendung direkt auf und umgeht die Netzwerkschicht, sodass Tests sehr schnell ausgeführt werden. Du musst den Uvicorn-Server nicht starten.


Verschiedene Anfragetypen testen

Beispiel

from fastapi import FastAPI
from fastapi.testclient import TestClient
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
    name: str
    price: float


@app.post("/items/")
async def create_item(item: Item):
    return {"name": item.name, "price": item.price}


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


@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Item):
    return {"item_id": item_id, "name": item.name}


@app.delete("/items/{item_id}")
async def delete_item(item_id: int):
    return {"deleted": item_id}


client = TestClient(app)


# POST-Anfrage testen
def test_create_item():
    response = client.post(
        "/items/",
        json={"name": "Foo", "price": 42.0},  # JSON-Anfragebody senden
    )
    assert response.status_code == 200
    assert response.json() == {"name": "Foo", "price": 42.0}


# GET-Anfrage testen
def test_read_item():
    response = client.get("/items/1")
    assert response.status_code == 200
    assert response.json() == {"item_id": 1}


# PUT-Anfrage testen
def test_update_item():
    response = client.put(
        "/items/1",
        json={"name": "Bar", "price": 50.0},
    )
    assert response.status_code == 200


# DELETE-Anfrage testen
def test_delete_item():
    response = client.delete("/items/1")
    assert response.status_code == 200
    assert response.json() == {"deleted": 1}

Query-Parameter und Anfrage-Header testen

Beispiel

from typing import Annotated
from fastapi import FastAPI, Header
from fastapi.testclient import TestClient

app = FastAPI()


@app.get("/items/")
async def read_items(
    skip: int = 0,
    limit: int = 10,
    x_token: Annotated[str | None, Header()] = None,
):
    return {"skip": skip, "limit": limit, "x_token": x_token}


client = TestClient(app)


# Query-Parameter testen
def test_read_items_with_params():
    response = client.get("/items/?skip=5&limit=20")
    assert response.status_code == 200
    assert response.json() == {"skip": 5, "limit": 20, "x_token": None}


# Request-Header testen
def test_read_items_with_header():
    response = client.get(
        "/items/",
        headers={"X-Token": "fake-token"},  # Benutzerdefinierte Request-Header senden
    )
    assert response.status_code == 200
    assert response.json()["x_token"] == "fake-token"

Exception-Responses testen

Beispiel

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

app = FastAPI()


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


client = TestClient(app)


# Normale Response testen
def test_read_item():
    response = client.get("/items/1")
    assert response.status_code == 200


# Fehlerantwort testen
def test_read_item_not_found():
    response = client.get("/items/0")
    assert response.status_code == 404
    assert response.json() == {"detail": "Item not found"}


# Validierungsfehler testen
def test_read_item_invalid_id():
    response = client.get("/items/foo")
    assert response.status_code == 422  # Validierung fehlgeschlagen

Tests mit pytest ausführen

Speichern Sie den Testcode alstest_main.py, dann ausführen:

$ pytest test_main.py

# 显示详细输出
$ pytest test_main.py -v

# 显示 print 输出
$ pytest test_main.py -s

pytest erkennt automatisch Dateien und Funktionentest_deren Namen mit dem Präfix "test_" beginnen.


Abhängigkeiten in Tests überschreiben

In Tests müssen Sie möglicherweise bestimmte Abhängigkeiten überschreiben (wie Datenbankverbindungen, Authentifizierungslogik):

Beispiel

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

app = FastAPI()


# Tatsächliche Abhängigkeitsfunktion
def get_query_param():
    return "real_value"


@app.get("/items/")
async def read_items(query: str = Depends(get_query_param)):
    return {"query": query}


client = TestClient(app)


def test_with_override():
    # Abhängigkeiten überschreiben
    app.dependency_overrides[get_query_param] = lambda: "test_value"

    response = client.get("/items/")
    assert response.json() == {"query": "test_value"}

    # Overrides löschen
    app.dependency_overrides.clear()

app.dependency_overridesErmöglicht das Ersetzen jeder Dependency-Funktion während des Tests, ideal zur Simulation von Szenarien wie Datenbankverbindungen und externen API-Aufrufen. Denken Sie daran, die Overrides nach dem Testen zu löschen.


Zusammenfassung

  • NutzungTestClientDie FastAPI-Anwendung direkt testen, ohne einen Server zu starten.
  • Unterstützt das Testen aller HTTP-Methoden, einschließlich GET, POST, PUT, DELETE usw.
  • Kann Query-Parameter, Request-Header, Request-Bodies, Exception-Antworten usw. testen.
  • Nutzungapp.dependency_overridesAbhängigkeiten in Tests überschreiben
  • Mit pytest können Sie Tests einfach organisieren und ausführen.
Weitere Erweiterungen