0Pricing
FastAPI Backend Development Bootcamp · 课时

测试 FastAPI 端点的集成

使用 FastAPI 的 `TestClient` 模拟请求，对 API 端点执行集成测试。

测试 FastAPI 端点的集成 是 CoddyKit 上的免费 FastAPI Backend Development Bootcamp 课时。 这是第 2 节课，共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 FastAPI Backend Development Bootcamp 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 FastAPI Backend Development Bootcamp 课程共包含 4 节课。

本课时的部分内容尚未翻译，以英文显示。

What is Integration Testing?

Welcome to integration testing! After learning about unit tests, it's time to see how different parts of your FastAPI application work together.

  • Unit tests check individual functions or components in isolation.
  • Integration tests verify that multiple components of your system interact correctly. For a FastAPI app, this means testing your API endpoints, checking if they handle requests, interact with dependencies, and return expected responses.

These tests ensure your API behaves as expected when all its pieces are connected.

Introducing FastAPI's TestClient

FastAPI provides a powerful tool called TestClient from fastapi.testclient. This client allows you to make HTTP requests to your FastAPI application without needing to run a live server.

  • It simulates requests directly in memory.
  • It's built on top of the popular httpx library.
  • It's perfect for quickly testing your API endpoints during development.

Let's see how to set it up!

Setting Up Your TestClient

To use TestClient, you first need to import your FastAPI application instance and then pass it to the TestClient constructor. This creates a client instance ready to send simulated requests.

Try running this example to see a basic setup:

from fastapi import FastAPI
from fastapi.testclient import TestClient

# 1. Define your FastAPI app
app = FastAPI()

# 2. Define a simple endpoint
@app.get("/hello")
async def read_hello():
    return {"message": "Hello Test!"}

# 3. Create a TestClient instance
client = TestClient(app)

# 4. Define a test function
def test_read_hello():
    # Use the client to make a GET request
    response = client.get("/hello")
    
    # Assertions to check the response
    assert response.status_code == 200
    assert response.json() == {"message": "Hello Test!"}
    print("Test Passed: /hello endpoint works!")

# This block makes the script runnable directly
if __name__ == "__main__":
    print("Running a simple test with TestClient...")
    test_read_hello()

Testing GET Requests

Making GET requests is straightforward. You simply call the .get() method on your TestClient instance, passing the path of the endpoint you want to test.

After making the request, you can access properties of the response object like .status_code and .json() to verify the outcome.

from fastapi import FastAPI
from fastapi.testclient import TestClient

app = FastAPI()

@app.get("/items/")
async def read_items():
    return [{"name": "Laptop"}, {"name": "Mouse"}]

client = TestClient(app)

def test_read_items():
    response = client.get("/items/")
    
    print(f"Status Code: {response.status_code}")
    print(f"Response JSON: {response.json()}")
    
    assert response.status_code == 200
    assert len(response.json()) == 2
    assert response.json()[0]["name"] == "Laptop"
    print("Test Passed: /items/ returns correct data!")

if __name__ == "__main__":
    print("Testing /items/ endpoint...")
    test_read_items()

Testing Path & Query Parameters

TestClient handles path and query parameters just like a real browser. Path parameters are included directly in the URL string, and query parameters can be added to the URL or passed via the params argument.

Using the params argument for query parameters is often cleaner and handles URL encoding automatically.

from fastapi import FastAPI
from fastapi.testclient import TestClient

app = FastAPI()

@app.get("/items/{item_id}")
async def read_item(item_id: int, q: str = None):
    if q:
        return {"item_id": item_id, "q": q}
    return {"item_id": item_id}

client = TestClient(app)

def test_read_item_with_query():
    # Path param 5, Query param q=hello
    response = client.get("/items/5", params={"q": "hello"})
    assert response.status_code == 200
    assert response.json() == {"item_id": 5, "q": "hello"}
    print("Test Passed: Path & Query params handled!")

def test_read_item_no_query():
    # Only path param 10
    response = client.get("/items/10")
    assert response.status_code == 200
    assert response.json() == {"item_id": 10}
    print("Test Passed: Path param only handled!")

if __name__ == "__main__":
    print("Testing path and query parameters...")
    test_read_item_with_query()
    test_read_item_no_query()

Testing POST Requests with JSON

For endpoints that expect a request body (like POST or PUT), you can pass a Python dictionary directly to the json argument of the client method. TestClient will automatically convert this dictionary into a JSON string and set the appropriate Content-Type header.

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

app = FastAPI()

class Product(BaseModel):
    name: str
    price: float
    description: str | None = None

@app.post("/products/")
async def create_product(product: Product):
    return product

client = TestClient(app)

def test_create_product():
    product_data = {"name": "Widget", "price": 29.99}
    response = client.post(
        "/products/",
        json=product_data
    )
    assert response.status_code == 200
    assert response.json() == {"name": "Widget", "price": 29.99, "description": None}
    print("Test Passed: POST request with JSON body!")

if __name__ == "__main__":
    print("Testing POST request...")
    test_create_product()

Overriding Dependencies for Testing

One of FastAPI's most powerful testing features is the ability to easily override dependencies. This is crucial for integration tests where you might want to:

  • Mock external services (e.g., a payment gateway).
  • Use a test database instead of the production one.
  • Inject specific test data or configurations.

You can temporarily replace a dependency function with a different one using app.dependency_overrides.

Applying Dependency Overrides

To override a dependency, you assign your mock function to the original dependency function in the app.dependency_overrides dictionary. After your test, it's vital to clear these overrides to prevent them from affecting other tests.

Let's see how to replace a 'real' setting with a 'test' setting:

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

app = FastAPI()

# Our 'real' dependency function
def get_current_env():
    return "production"

@app.get("/environment/")
async def get_environment(env: str = Depends(get_current_env)):
    return {"current_environment": env}

client = TestClient(app)

def test_get_environment_default():
    response = client.get("/environment/")
    assert response.status_code == 200
    assert response.json() == {"current_environment": "production"}
    print("Default environment test passed!")

def test_get_environment_override():
    # Our mock dependency function for testing
    def override_get_current_env():
        return "test"
    
    # Apply the override
    app.dependency_overrides[get_current_env] = override_get_current_env
    
    response = client.get("/environment/")
    assert response.status_code == 200
    assert response.json() == {"current_environment": "test"}
    print("Overridden environment test passed!")
    
    # IMPORTANT: Clear overrides after the test
    app.dependency_overrides.clear()

if __name__ == "__main__":
    print("Testing dependency overrides...")
    test_get_environment_default()
    test_get_environment_override()

Ensuring Cleanup of Overrides

Failing to clear app.dependency_overrides can lead to 'leaky' tests, where an override from one test unintentionally affects subsequent tests. Always make sure to reset app.dependency_overrides, typically by setting it back to an empty dictionary or using .clear().

This ensures each test runs in a clean, predictable state.

Test Your Knowledge!

Which of the following statements about FastAPI's TestClient is TRUE?

Recap & Next Steps

Great job! You've learned how to perform integration tests on your FastAPI application:

  • We explored what integration testing is and why it's crucial.
  • You mastered setting up and using FastAPI's TestClient to simulate various HTTP requests.
  • We covered testing GET and POST requests, including handling path, query, and JSON body parameters.
  • You now understand how to effectively use dependency overrides to isolate and control your test environment.

These skills are essential for building robust and reliable FastAPI applications. Keep practicing, and you'll be writing comprehensive tests in no time!

常见问题解答

「测试 FastAPI 端点的集成」课时是免费的吗？

是的 — 「测试 FastAPI 端点的集成」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 FastAPI Backend Development Bootcamp 课程的其余内容，请升级到 CoddyKit PRO。 FastAPI Backend Development Bootcamp 课程共包含 4 节课。

「测试 FastAPI 端点的集成」这节课中我会学到什么？

使用 FastAPI 的 `TestClient` 模拟请求，对 API 端点执行集成测试。 你通过在浏览器中直接运行的动手代码来练习 FastAPI Backend Development Bootcamp，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 FastAPI Backend Development Bootcamp 需要有经验吗？

无需任何先前经验。CoddyKit 上的 FastAPI Backend Development Bootcamp 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。 这是第 2 节课，共 4 节。

「测试 FastAPI 端点的集成」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 FastAPI Backend Development Bootcamp 课中编写并运行代码吗？

能。每节 FastAPI Backend Development Bootcamp 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. 使用 Pytest 进行单元测试
  2. 测试 FastAPI 端点的集成
  3. 调试 FastAPI 应用
  4. 在 FastAPI 测试中模拟依赖
← 返回 FastAPI Backend Development Bootcamp