This is a REST API for a Pizza delivery service built for fun and learning with FastAPI, SQLAlchemy and SQLite.
METHOD | ROUTE | FUNCTIONALITY | ACCESS |
---|---|---|---|
POST | /auth/signup/ |
Register new user | All users |
POST | /auth/login/ |
Login user | All users |
POST | /orders/order/ |
Place an order | All users |
PUT | /orders/order/update/{order_id}/ |
Update an order | All users |
PUT | /orders/order/status/{order_id}/ |
Update order status | Superuser |
DELETE | /orders/order/delete/{order_id}/ |
Delete/Remove an order | All users |
GET | /orders/user/orders/ |
Get user's orders | All users |
GET | /orders/orders/ |
List all orders made | Superuser |
GET | /orders/orders/{order_id}/ |
Retrieve an order | Superuser |
GET | /orders/user/order/{order_id}/ |
Get user's specific order | |
GET | /docs/ |
View API documentation | All users |
- localhost:8000/docs
- orders table
-
Install Python
-
Git clone the project with
git clone https://github.com/jod35/Pizza-Delivery-API.git
-
Create your virtualenv with
Pipenv
orvirtualenv
and activate it. -
Install the requirements with
pip install -r requirements.txt
-
Create your database by running
python init_db.py
-
Finally run the API ``` uvicorn main:app ``