This is a Test E-commerce API created using Python and FASTAPI. The database used for the project is PostgresSQL.
- Python 3.10.8
- Postgres:15.1-alpine
- Pytest
- FastAPI
| Endpoint | HTTP Method | CRUD Method | Result |
|---|---|---|---|
| / | GET | READ | Check that the API is running |
| api/v1/products/create (protected) | POST | CREATE | Create a product |
| api/v1/auth/signup | POST | CREATE | Create new user |
| api/v1/auth/login | POST | CREATE | Login user |
| api/v1/auth/me (protected) | GET | READ | Read current user details |
| api/v1/orders/create (protected) | POST | CREATE | Create order |
| api/v1/orders/get_specific_order/{id} (protected) | POST | READ | Get specific order |
| api/v1/orders/update/{id} (protected) | POST | CREATE | Update specific order |
Most routes are protected by JWT authentication. To get a token, you need to register and login using the /api/v1/auth/signup and /api/v1/auth/login routes.
Documentation related to the project is available on /docs or /redoc paths with Swagger or ReDoc.
To run the project, you need to have docker installed on your machine. You can download docker from here.
You also need to have docker-compose installed on your machine. You can download docker-compose from here.
After installing docker and docker compose, you can run the project by running the following command:
$ docker-compose up --build
This will build the docker images and run the project. You can then access the project on http://localhost:8000/
Tests for this project are defined in the tests/ folder.
This project uses pytest to define tests
because it allows you to use the assert keyword with good formatting
for failed assertations.
To run all the tests of a project, ensure that docker is running and simply run the command docker-compose exec app pytest . :
$ docker-compose exec app pytest .
================================================= test session starts ==================================================
platform linux -- Python 3.10.8, pytest-7.2.1, pluggy-1.0.0
rootdir: /usr/src/fast_api
plugins: anyio-3.6.2, asyncio-0.20.3
asyncio: mode=strict
collected 10 items
tests/app/core/test_generate_unique_reference_code.py .. [ 20%]
tests/app/server/api_v1/test_api_is_running.py . [ 30%]
tests/app/server/api_v1/test_create_order_endpoint.py . [ 40%]
tests/app/server/api_v1/test_create_product_endpoint.py . [ 50%]
tests/app/server/api_v1/test_create_user_signup_endpoint.py .. [ 70%]
tests/app/server/api_v1/test_get_specific_order.py . [ 80%]
tests/app/server/api_v1/test_me_endpoint.py . [ 90%]
tests/app/server/api_v1/test_user_login_endpoint.py . [100%]
==================================================================== 10 passed in 11.14s =====================================================================