Testing

Warning

The current page still doesn’t have a translation for this language.

But you can help translating it: Contributing.

Thanks to Starlette, testing FastAPI applications is easy and enjoyable.

It is based on HTTPX, which in turn is designed based on Requests, so it’s very familiar and intuitive.

With it, you can use pytest directly with FastAPI.

Using TestClient

Info

To use TestClient, first install httpx.

E.g. pip install httpx.

Import TestClient.

Create a TestClient by passing your FastAPI application to it.

Create functions with a name that starts with test_ (this is standard pytest conventions).

Use the TestClient object the same way as you do with httpx.

Write simple assert statements with the standard Python expressions that you need to check (again, standard pytest).

  1. from fastapi import FastAPI
  2. from fastapi.testclient import TestClient
  4. app = FastAPI()
  7. @app.get("/")
  8. async def read_main():
  9.     return {"msg": "Hello World"}
  12. client = TestClient(app)
  15. def test_read_main():
  16.     response = client.get("/")
  17.     assert response.status_code == 200
  18.     assert response.json() == {"msg": "Hello World"}

Tip

Notice that the testing functions are normal def, not async def.

And the calls to the client are also normal calls, not using await.

This allows you to use pytest directly without complications.

Technical Details

You could also use from starlette.testclient import TestClient.

FastAPI provides the same starlette.testclient as fastapi.testclient just as a convenience for you, the developer. But it comes directly from Starlette.

Tip

If you want to call async functions in your tests apart from sending requests to your FastAPI application (e.g. asynchronous database functions), have a look at the Async Tests in the advanced tutorial.

Separating tests

In a real application, you probably would have your tests in a different file.

And your FastAPI application might also be composed of several files/modules, etc.

FastAPI app file

Let’s say you have a file structure as described in Bigger Applications:

  1. .
  2. ├── app
  3. │   ├── __init__.py
  4. │   └── main.py

In the file main.py you have your FastAPI app:

  1. from fastapi import FastAPI
  3. app = FastAPI()
  6. @app.get("/")
  7. async def read_main():
  8.     return {"msg": "Hello World"}

Testing file

Then you could have a file test_main.py with your tests. It could live on the same Python package (the same directory with a __init__.py file):

  1. .
  2. ├── app
  3. │   ├── __init__.py
  4. │   ├── main.py
  5. │   └── test_main.py

Because this file is in the same package, you can use relative imports to import the object app from the main module (main.py):

  1. from fastapi.testclient import TestClient
  3. from .main import app
  5. client = TestClient(app)
  8. def test_read_main():
  9.     response = client.get("/")
  10.     assert response.status_code == 200
  11.     assert response.json() == {"msg": "Hello World"}

…and have the code for the tests just like before.

Testing: extended example

Now let’s extend this example and add more details to see how to test different parts.

Extended FastAPI app file

Let’s continue with the same file structure as before:

  1. .
  2. ├── app
  3. │   ├── __init__.py
  4. │   ├── main.py
  5. │   └── test_main.py

Let’s say that now the file main.py with your FastAPI app has some other path operations.

It has a GET operation that could return an error.

It has a POST operation that could return several errors.

Both path operations require an X-Token header.

Python 3.9+Python 3.6+Python 3.10+ non-AnnotatedPython 3.6+ non-Annotated

  1. from typing import Annotated
  3. from fastapi import FastAPI, Header, HTTPException
  4. from pydantic import BaseModel
  6. fake_secret_token = "coneofsilence"
  8. fake_db = {
  9.     "foo": {"id": "foo", "title": "Foo", "description": "There goes my hero"},
  10.     "bar": {"id": "bar", "title": "Bar", "description": "The bartenders"},
  11. }
  13. app = FastAPI()
  16. class Item(BaseModel):
  17.     id: str
  18.     title: str
  19.     description: str | None = None
  22. @app.get("/items/{item_id}", response_model=Item)
  23. async def read_main(item_id: str, x_token: Annotated[str, Header()]):
  24.     if x_token != fake_secret_token:
  25.         raise HTTPException(status_code=400, detail="Invalid X-Token header")
  26.     if item_id not in fake_db:
  27.         raise HTTPException(status_code=404, detail="Item not found")
  28.     return fake_db[item_id]
  31. @app.post("/items/", response_model=Item)
  32. async def create_item(item: Item, x_token: Annotated[str, Header()]):
  33.     if x_token != fake_secret_token:
  34.         raise HTTPException(status_code=400, detail="Invalid X-Token header")
  35.     if item.id in fake_db:
  36.         raise HTTPException(status_code=400, detail="Item already exists")
  37.     fake_db[item.id] = item
  38.     return item
  1. from typing import Annotated, Union
  3. from fastapi import FastAPI, Header, HTTPException
  4. from pydantic import BaseModel
  6. fake_secret_token = "coneofsilence"
  8. fake_db = {
  9.     "foo": {"id": "foo", "title": "Foo", "description": "There goes my hero"},
  10.     "bar": {"id": "bar", "title": "Bar", "description": "The bartenders"},
  11. }
  13. app = FastAPI()
  16. class Item(BaseModel):
  17.     id: str
  18.     title: str
  19.     description: Union[str, None] = None
  22. @app.get("/items/{item_id}", response_model=Item)
  23. async def read_main(item_id: str, x_token: Annotated[str, Header()]):
  24.     if x_token != fake_secret_token:
  25.         raise HTTPException(status_code=400, detail="Invalid X-Token header")
  26.     if item_id not in fake_db:
  27.         raise HTTPException(status_code=404, detail="Item not found")
  28.     return fake_db[item_id]
  31. @app.post("/items/", response_model=Item)
  32. async def create_item(item: Item, x_token: Annotated[str, Header()]):
  33.     if x_token != fake_secret_token:
  34.         raise HTTPException(status_code=400, detail="Invalid X-Token header")
  35.     if item.id in fake_db:
  36.         raise HTTPException(status_code=400, detail="Item already exists")
  37.     fake_db[item.id] = item
  38.     return item
  1. from typing import Union
  3. from fastapi import FastAPI, Header, HTTPException
  4. from pydantic import BaseModel
  5. from typing_extensions import Annotated
  7. fake_secret_token = "coneofsilence"
  9. fake_db = {
  10.     "foo": {"id": "foo", "title": "Foo", "description": "There goes my hero"},
  11.     "bar": {"id": "bar", "title": "Bar", "description": "The bartenders"},
  12. }
  14. app = FastAPI()
  17. class Item(BaseModel):
  18.     id: str
  19.     title: str
  20.     description: Union[str, None] = None
  23. @app.get("/items/{item_id}", response_model=Item)
  24. async def read_main(item_id: str, x_token: Annotated[str, Header()]):
  25.     if x_token != fake_secret_token:
  26.         raise HTTPException(status_code=400, detail="Invalid X-Token header")
  27.     if item_id not in fake_db:
  28.         raise HTTPException(status_code=404, detail="Item not found")
  29.     return fake_db[item_id]
  32. @app.post("/items/", response_model=Item)
  33. async def create_item(item: Item, x_token: Annotated[str, Header()]):
  34.     if x_token != fake_secret_token:
  35.         raise HTTPException(status_code=400, detail="Invalid X-Token header")
  36.     if item.id in fake_db:
  37.         raise HTTPException(status_code=400, detail="Item already exists")
  38.     fake_db[item.id] = item
  39.     return item

Tip

Prefer to use the Annotated version if possible.

  1. from fastapi import FastAPI, Header, HTTPException
  2. from pydantic import BaseModel
  4. fake_secret_token = "coneofsilence"
  6. fake_db = {
  7.     "foo": {"id": "foo", "title": "Foo", "description": "There goes my hero"},
  8.     "bar": {"id": "bar", "title": "Bar", "description": "The bartenders"},
  9. }
  11. app = FastAPI()
  14. class Item(BaseModel):
  15.     id: str
  16.     title: str
  17.     description: str | None = None
  20. @app.get("/items/{item_id}", response_model=Item)
  21. async def read_main(item_id: str, x_token: str = Header()):
  22.     if x_token != fake_secret_token:
  23.         raise HTTPException(status_code=400, detail="Invalid X-Token header")
  24.     if item_id not in fake_db:
  25.         raise HTTPException(status_code=404, detail="Item not found")
  26.     return fake_db[item_id]
  29. @app.post("/items/", response_model=Item)
  30. async def create_item(item: Item, x_token: str = Header()):
  31.     if x_token != fake_secret_token:
  32.         raise HTTPException(status_code=400, detail="Invalid X-Token header")
  33.     if item.id in fake_db:
  34.         raise HTTPException(status_code=400, detail="Item already exists")
  35.     fake_db[item.id] = item
  36.     return item

Tip

Prefer to use the Annotated version if possible.

  1. from typing import Union
  3. from fastapi import FastAPI, Header, HTTPException
  4. from pydantic import BaseModel
  6. fake_secret_token = "coneofsilence"
  8. fake_db = {
  9.     "foo": {"id": "foo", "title": "Foo", "description": "There goes my hero"},
  10.     "bar": {"id": "bar", "title": "Bar", "description": "The bartenders"},
  11. }
  13. app = FastAPI()
  16. class Item(BaseModel):
  17.     id: str
  18.     title: str
  19.     description: Union[str, None] = None
  22. @app.get("/items/{item_id}", response_model=Item)
  23. async def read_main(item_id: str, x_token: str = Header()):
  24.     if x_token != fake_secret_token:
  25.         raise HTTPException(status_code=400, detail="Invalid X-Token header")
  26.     if item_id not in fake_db:
  27.         raise HTTPException(status_code=404, detail="Item not found")
  28.     return fake_db[item_id]
  31. @app.post("/items/", response_model=Item)
  32. async def create_item(item: Item, x_token: str = Header()):
  33.     if x_token != fake_secret_token:
  34.         raise HTTPException(status_code=400, detail="Invalid X-Token header")
  35.     if item.id in fake_db:
  36.         raise HTTPException(status_code=400, detail="Item already exists")
  37.     fake_db[item.id] = item
  38.     return item

Extended testing file

You could then update test_main.py with the extended tests:

  1. from fastapi.testclient import TestClient
  3. from .main import app
  5. client = TestClient(app)
  8. def test_read_item():
  9.     response = client.get("/items/foo", headers={"X-Token": "coneofsilence"})
  10.     assert response.status_code == 200
  11.     assert response.json() == {
  12.         "id": "foo",
  13.         "title": "Foo",
  14.         "description": "There goes my hero",
  15.     }
  18. def test_read_item_bad_token():
  19.     response = client.get("/items/foo", headers={"X-Token": "hailhydra"})
  20.     assert response.status_code == 400
  21.     assert response.json() == {"detail": "Invalid X-Token header"}
  24. def test_read_inexistent_item():
  25.     response = client.get("/items/baz", headers={"X-Token": "coneofsilence"})
  26.     assert response.status_code == 404
  27.     assert response.json() == {"detail": "Item not found"}
  30. def test_create_item():
  31.     response = client.post(
  32.         "/items/",
  33.         headers={"X-Token": "coneofsilence"},
  34.         json={"id": "foobar", "title": "Foo Bar", "description": "The Foo Barters"},
  35.     )
  36.     assert response.status_code == 200
  37.     assert response.json() == {
  38.         "id": "foobar",
  39.         "title": "Foo Bar",
  40.         "description": "The Foo Barters",
  41.     }
  44. def test_create_item_bad_token():
  45.     response = client.post(
  46.         "/items/",
  47.         headers={"X-Token": "hailhydra"},
  48.         json={"id": "bazz", "title": "Bazz", "description": "Drop the bazz"},
  49.     )
  50.     assert response.status_code == 400
  51.     assert response.json() == {"detail": "Invalid X-Token header"}
  54. def test_create_existing_item():
  55.     response = client.post(
  56.         "/items/",
  57.         headers={"X-Token": "coneofsilence"},
  58.         json={
  59.             "id": "foo",
  60.             "title": "The Foo ID Stealers",
  61.             "description": "There goes my stealer",
  62.         },
  63.     )
  64.     assert response.status_code == 400
  65.     assert response.json() == {"detail": "Item already exists"}

Whenever you need the client to pass information in the request and you don’t know how to, you can search (Google) how to do it in httpx, or even how to do it with requests, as HTTPX’s design is based on Requests’ design.

Then you just do the same in your tests.

E.g.:

  • To pass a path or query parameter, add it to the URL itself.
  • To pass a JSON body, pass a Python object (e.g. a dict) to the parameter json.
  • If you need to send Form Data instead of JSON, use the data parameter instead.
  • To pass headers, use a dict in the headers parameter.
  • For cookies, a dict in the cookies parameter.

For more information about how to pass data to the backend (using httpx or the TestClient) check the HTTPX documentation.

Info

Note that the TestClient receives data that can be converted to JSON, not Pydantic models.

If you have a Pydantic model in your test and you want to send its data to the application during testing, you can use the jsonable_encoder described in JSON Compatible Encoder.

Run it

After that, you just need to install pytest:

Testing - 图1

It will detect the files and tests automatically, execute them, and report the results back to you.

Run the tests with:

Testing - 图2