Delivery Fee Calculator API

Description

A single endpoint API that calculates the delivery fee based on the information in the request payload (JSON) and includes the calculated delivery fee in the response payload (JSON). It is built using Python, FastAPI, Poetry as the package manager, and Pydantic as the data validation tool.

Tech Stack Used

Dependencies

The API has been dockerized and will require docker desktop to run successfully.

• Install Docker Desktop

Running API

• Make sure the docker daemon is running.

• Make sure you are in the root directory of the project. The root directory contains the Dockerfile.

• Run the docker compose command below in the project root directory to start the application.

docker compose up --build

Testing

You can either test the api with FastAPI docs:

sample request:

{
    "cart_value": 790,
    "delivery_distance": 2235,
    "amount_of_items": 4,
    "time": "2024-01-15T13:00:00Z"
}

Output:

{"delivery_fee":710}

Pytest

• Test have been defined for the API using Pytest.
• Make sure the previously created container is running, and you are in the root directory.
• Run the command below to run test.

docker compose exec web pytest --cov -s --cov-report term-missing 

---

Test coverage report :

app/api/health/test_health_endpoint.py .
app/tests/test_endpoint.py .............
app/tests/test_helpers.py ...................

---------- coverage: platform linux, python 3.10.12-final-0 ----------
Name                                            Stmts   Miss  Cover   Missing
-----------------------------------------------------------------------------
app/__init__.py                                     0      0   100%
app/api/__init__.py                                 0      0   100%
app/api/health/__init__.py                          0      0   100%
app/api/health/routes.py                           16      0   100%
app/api/health/schemas.py                          15      0   100%
app/api/health/test_health_endpoint.py             28      0   100%
app/api/schemas.py                                  4      0   100%
app/api/v1/__init__.py                              0      0   100%
app/api/v1/delivery_fee_calculator/helpers.py      36      0   100%
app/api/v1/delivery_fee_calculator/routes.py       12      0   100%
app/api/v1/delivery_fee_calculator/schemas.py      10      0   100%
app/api/v1/routes.py                                4      0   100%
app/config/__init__.py                              0      0   100%
app/config/settings.py                             21      0   100%
app/main.py                                         2      0   100%
app/server/__init__.py                              0      0   100%
app/server/setup.py                                10      0   100%
app/tests/__init__.py                               0      0   100%
app/tests/test_endpoint.py                         36      0   100%
app/tests/test_helpers.py                          25      0   100%
-----------------------------------------------------------------------------
TOTAL                                             219      0   100%
Coverage XML written to file coverage.xml


================================ 33 passed in 1.19s ================================