您如何测试FastAPI应用程序？

Question

您如何测试FastAPI应用程序？

Accepted Answer

FastAPI由于其**`TestClient`**（基于Starlette/httpx构建）和其**依赖注入**系统而具有高度的可测试性，这使模拟依赖变得轻而易举。测试通常使用`pytest`和`TestClient`向应用程序发送请求，无需运行服务器。

## 使用TestClient的基本端点测试

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

client = TestClient(app)

def test_read_item():
    response = client.get("/items/5")            # send a request to the app in-process
    assert response.status_code == 200
    assert response.json() == {"item_id": 5}

def test_create_item():
    response = client.post("/items", json={"name": "Phone", "price": 999})
    assert response.status_code == 201
    assert response.json()["name"] == "Phone"

def test_validation_error():
    response = client.post("/items", json={"name": "Phone"})   # missing price
    assert response.status_code == 422                          # FastAPI validates automatically
```

`TestClient`将真实请求发送到您的应用程序中（无需服务器），因此您可以测试完整的流程 — 路由、验证、序列化 — 并对状态码和JSON响应进行断言。

## 覆盖依赖项（清洁测试的关键）

```python
# override a dependency with a mock/test version — no real database needed
def override_get_db():
    return test_db_session

app.dependency_overrides[get_db] = override_get_db   # swap the real dependency

def test_with_test_db():
    response = client.get("/users")
    # uses the test database via the override
    app.dependency_overrides.clear()                 # reset after
```

FastAPI的`dependency_overrides`允许您**替换任何依赖项**（数据库会话、身份验证、外部服务）为测试替身 — 这是快速、隔离测试的基础，通过DI设计使之变得轻而易举。

## 测试受保护的端点

```python
def test_protected():
    # override the auth dependency to simulate a logged-in user
    app.dependency_overrides[get_current_user] = lambda: fake_user
    response = client.get("/me")
    assert response.status_code == 200
```

## 测试策略

```text
✓ Use a TEST database (separate, or transactions rolled back per test)
✓ Override dependencies (DB, auth, external APIs) for isolation
✓ Test: status codes, response shapes, validation (422s), auth/permissions, edge cases
✓ For async-specific code, use httpx.AsyncClient / pytest-asyncio
✓ Tools: pytest, factory libraries for test data, coverage.py
```

## 为什么这很重要

测试对于可靠的应用程序至关重要，FastAPI特别容易测试 — 理解如何测试它对代码质量很重要，也因为该框架*为可测试性而设计*。

**`TestClient`**使得在进程内测试完整的请求/响应流变得容易（无需服务器），验证路由、验证、序列化和响应，就如同客户端会体验的那样。

突出特性是**依赖项覆盖**：由于FastAPI使用依赖注入，您可以轻而易举地通过`app.dependency_overrides`将任何依赖项 — 数据库会话、身份验证、外部服务 — 替换为测试替身，从而无需真实基础设施即可实现快速、隔离的测试（这种可测试性是DI设计的主要优势）。

了解如何使用TestClient、为隔离覆盖依赖项（测试数据库、模拟的身份验证/服务）、测试受保护的端点，以及构建合理的测试策略（状态码、响应形状、验证、身份验证、边界情况），这对于构建强大的FastAPI应用程序来说是重要的高级知识。

经过充分测试的API可以捕获回归问题并实现自信的重构，FastAPI的测试工具使彻底的测试变得直接，使这成为一个频繁相关、专业重要的话题。