This is an example project showcasing several simple APIs alongside corresponding Pytest tests to validate their functionality.

You have the flexibility to install only the basic prerequisites and still engage with the code. However, we highly recommend installing the advanced prerequisites, as they significantly enhance the development experience. This documentation assumes that you have installed the advanced ones.

• Python (tested on Python 3.12.1)

Once you have installed Python, you can effortlessly execute the project using the following command:

PYTHONPATH=. python ./fastapi_example/main.py

• Docker
• Make

Warning: This project was developed and tested on MacOS, which means that certain features may not work seamlessly on Linux or Windows.

After cloning the repository and navigating to its directory, you can utilize the provided Makefile commands to run the project.

make build
make run

Then, open the following link in your web browser to check it out: http://localhost:3000/

make python

Then, open the following link in your web browser to check it out: http://localhost:80/

This project comprises two requirement files:

• requirements.txt: This file includes only the essentials needed to run the project in a production environment and is used during the Docker image building process.
• tests/dev_requirements.txt: This file serves for running Pytests, checking code coverage, and handling other development-related tasks.

Both files are generated with pip-compile (which is under pip-tools) based on the next files:

• requirements.in
• tests/dev_requirements.in

To remove all Python libraries from the environment:

make pip_uninstall

To upgrade the top-level libraries and all their dependencies while getting rid of the old requirements that are no longer needed in the requirements files, employ:

make upgrade

To also install all the requirements_dev.txt file dependencies, use:

make pip_upgrade_dev

These commands update the installed libraries and change the requirements files. They also upgrade and pin requirements.in and tests/dev_requirements.in

1. If you want to add top level dependency, update the relevant requirements.in file
2. Recompile the requirements files and install the requirements.txt file with: make pip_upgrade
3. If the change pertains to the requirements_dev.txt file, also execute: make test

• make help: Displays all available make targets.
• make test: Executes Pytests after installing the development requirements, including verification of the import order.
• make coverage: Validates the test coverage after installing the development requirements; it should achieve 100%.

• Main Script: fastapi_example/main.py

• Configurations: fastapi_example/config.py

  Here you can configure the port, number of workers in the app, enable json log format and much more.

• Project Makefile: Makefile

  Useful commands that can be run with make, or used as a cheatsheet.

• API Endpoints: fastapi_example/api/routes/*

  These files represent the heart of the application, defining how it responds to various requests. Each function with a path annotation acts as an individual endpoint. Adding a new endpoint is simple: create a function here and specify its path.

• FastAPI Top Level Route: fastapi_example/api/group_routers.py This file acts as a traffic manager, organizing all the routes in to one route, that will be used by the application.

To add a new endpoint to the application:

1. Open one of the files under fastapi_example/api/routes
2. Create a new function and annotate it with the desired path (e.g., @router.get('/new_endpoint')).
3. That's it. Run the server, and you can call your new endpoint.

Bonus: If you wish to add a new file that will contain endpoints under fastapi_example/api/routes, you can. Just create it, instantiate a new router and add the new router to fastapi_example/api/group_routers.py.