Pizza-delivery-API-Django
Pizza-delivery-API-Django copied to clipboard
jod35
This is a REST API for a Pizza delivery service implemented with Django.
PIZZA DELIVERY API
This is a REST API for a Pizza delivery service built for fun and learning with FastAPI, SQLAlchemy and PostgreSQL. The video playlist is here
ROUTES TO IMPLEMENT
| METHOD | ROUTE | FUNCTIONALITY | ACCESS |
|---|---|---|---|
| POST | /auth/signup/ |
Register new user | All users |
| POST | /auth/jwt/create/ |
Login user | All users |
| POST | /auth/jwt/refresh/ |
Refresh the access token | All users |
| POST | /auth/jwt/verify/ |
Verify the validity of a token | All users |
| POST | /orders/ |
Place an order | All users |
| POST | /orders/ |
Get all orders | All users |
| GET | /order/{order_id}/ |
Retrieve an order | Superuser |
| PUT | /orders/{order_id}/ |
Update an order | All users |
| PUT | /update-status/{order_id}/ |
Update order status | Superuser |
| DELETE | /delete/{order_id}/ |
Delete/Remove an order | All users |
| GET | /user/{user_id}/orders/ |
Get user's orders | All users |
| GET | /user/{user_id}/order/{order_id}/ |
Get user's specific order | |
| GET | /docs/ |
View API documentation | All users |
How to run the Project
- Install Postgreql
- Install Python
- Git clone the project with
git clone https://github.com/jod35/Pizza-Delivery-API.git - Create your virtualenv with
Pipenvorvirtualenvand activate it. - Install the requirements with
pip install -r requirements.txt - Create you database with
python manage.py runserver - Finally run the API ``` python manage.py runserver ``
jod35