The api arquitecture is based on the good practices for Fast-API by @tialongo, for more information check https://fastapi.tiangolo.com
API Reference
All the models should have the same acces methods, you should check http://localhost:8000/docs for testings all the methods
Get all items
| Parameter | Type | Description |
|---|---|---|
token |
string |
Required. Your API key |
Get item
| Parameter | Type | Description |
|---|---|---|
id |
string |
Required. Id of item to fetch |
Post Item
| Parameter | Type | Description |
|---|---|---|
id |
string |
Required. Id of item to fetch |
Put Item
| Parameter | Type | Description |
|---|---|---|
id |
string |
Required. Id of item to fetch |
Delete Item
| Parameter | Type | Description |
|---|---|---|
id |
string |
Required. Id of item to fetch |
Run Locally
Clone the project
git clone ${project_link}Go to the project directory
Create a virutal environment
Activate the virutalenv
Install dependencies
python3 -m pip install -r requirements.txt
Update the db
alembic revision --autogenerate -m "made some changes"
alembic upgrade head Start the server
Start the celery server
cd app
celery -A celery_app worker -B -l info Deployment
To deploy this project run
Documentation
License
The project is licensed only for the use by the team.