Testing the API endpoints
FastAPI uses the pytest
framework to run its test classes. So, before we create our test classes, first, we need to install the pytest
framework using the pip
command:
pip install pytest
FastAPI has a module called fastapi.testclient
where all components are Request
-based, including the TestClient
class. To access all the API endpoints, we need the TestClient
object. But first, we need to create a folder such as test
, which will contain test modules where we implement our test methods. We place our test methods outside main.py
or the router modules to maintain clean code and organization.
Writing the unit test cases
It is a best practice to write one test module per router component, except for cases where there is a tight connection between these routers. We place these test modules inside the test
directory. To pursue the automated testing, we need to import the APIRouter
instance or the FastAPI
instance into the test module to set up TestClient...