According to Merriam-Webster Dictionary, a Bucket List is a list of things that one has not done before but wants to do before dying. This is a checkpoint 2 project used to evaluate Python beginner
| Features | Endpoint | Public |
|---|---|---|
| Register | POST /auth/register | True |
| Authentication | POST /auth/login | True |
| Create Bucketlist | POST /bucketlists/ | False |
| Fetch Bucketlists | GET /bucketlists/ | False |
| Fetch Single Bucketlists | GET /bucketlists/:id | False |
| Update bucketlist record | PUT /bucketlists/:id | False |
| Delete bucketlist record | DELETE /bucketlists/:id | False |
| Create Bucketlist Item | POST /bucketlists/:id/items | False |
| Fetch Bucketlists Items | GET /bucketlists/:id/items | False |
| Fetch Single Bucketlists item | GET /bucketlists/:id/items/:itemId | False |
| Update bucketlist item record | PUT /bucketlists/:id/items/:itemId | False |
| Delete bucketlist item record | DELETE /bucketlists/:id/items/:itemId | False |
All dependecies can be found in requirements.txt
- Clone project git clone
git@github.com:andela-snwuguru/bucketlist-api.git - Create a virtual environment
mkvirtualenv bucketlist - Install dependecies
pip install -r requirements.txt - Navigate to project folder
cd ~/bucketlist-api - Run migrationscript
python script.py db migrate
python script.py db upgrade
- Run Project
python run.py
Request
--------
http POST http://127.0.0.1:5000/api/v1.0/auth/register username=guru password=test email=guru@mail.com
Response
--------
{
"data": {
"date_created": "2016-05-19 19:37:20",
"date_modified": "2016-05-19 19:37:20",
"email": "guru@mail.com",
"id": 7,
"username": "guru"
}
}
Request
--------
http POST http://127.0.0.1:5000/api/v1.0/auth/login username=guru password=test
Response
--------
{
"data": {
"date_created": "2016-05-19 19:37:20",
"date_modified": "2016-05-19 19:37:20",
"email": "guru@mail.com",
"id": 7,
"username": "guru"
},
"token": "098f6bcd4621d373cade4e832627b4f6|7|.Ch-n_A._bH9Hx_kpibiIlRHvFRZbVt-6UM"
}
Api documentation is still in progress, it Will soon be available.