- Python3 & Python3 dev(e.g.
...-dev
) packages - pip3
- SQLite3
- Flask
- SQLAlchemy
- Gunicorn
It's quite simple:
cd path_to_project_root
chmod +x setup.sh # just a reminder to make .sh files executable :)
./setup.sh
There are 2 intended scenarios how to start the app:
- Run it with flask dev server
- Run it with gunicorn by executing
run_app.sh
Method | URL | Parameters | Response |
---|---|---|---|
POST | api/v1/users | int id, string first_name, string middle_name, string last_name |
A list of User object filtered by request params. Example response: [{ "first_name": "test1", "id": 2, "last_name": "test1", "middle_name": "test1" }] |
GET | api/v1/users | - | A list that contains all User objects |
Method | URL | Parameters | Response |
---|---|---|---|
GET | api/v1/users/query | int id, string first_name, string middle_name, string last_name Query example: first_name=test_name,middle_name=test_middle_name |
A list of User object filtered by query params. Example response: [{ "first_name": "test1", "id": 2, "last_name": "test1", "middle_name": "test1" }] |
There are some .sh
helpers to use if you don't really want to bother with Python and it's enviroment.
Anton Kostryukov
anton97kos@gmail.com
+79108800986
2018