/SimpleEventsCollectingAPI

MVP of SimpleEventsCollectingAPI

Primary LanguagePython

SimpleEventsCollectingAPI

MVP of SimpleEventsCollectingAPI

Tests Linting

Quickstart

You must have docker and docker-compose tools installed to run the application. Run command below:

make docker

Or use make local command to run app locally.

Tests

Simply run pytest from root dir:

pytest

Also you can run linting checks:

make lint

Routes

User endpoints:
---------------
POST    /api/add/user               - Add user
GET     /api/get/user/{user_id}     - Get user
PATCH   /api/update/user/{user_id}  - Update user
DELETE  /api/delete/user/{user_id}  - Delete user


Tariff endpoints:
----------------
POST    /api/add/tariff                 - Add tariff
GET     /api/get/tariff/{tariff_id}     - Get tariff
PATCH   /api/update/tariff/{tariff_id}  - Update tariff
DELETE  /api/delete/tariff/{tariff_id}  - Delete tariff


Events enpoints:
----------------
POST    /api/add/event                  - Add event 
                                        (will not be added if user not exist)
GET     /api/get/event/{event_id}       - Get event
PATCH   /api/update/event/{event_id}    - Update event
DELETE  /api/delete/event/{event_id}    - Delete event

Additional docs are autogenerated and available by the link below. Just load the project.

127.0.0.1:8000/redoc

Contacts

Up