According to the Oxford Dictionary, a bucket list is a number of experiences or achievements that a person hopes to have or accomplish during their lifetime.
This is a RESTful API for an online Bucket List service using Flask.
Clone the repo from GitHub:
git clone https://github.com/mbithenzomo/flask-bucketlist-api
Fetch from the develop branch:
git fetch origin develop
Navigate to the root folder:
cd flask-bucketlist-api
Install the required packages:
pip install -r requirements.txt
Initialize, migrate, and upgrade the database:
python manage.py db init
python manage.py db migrate
python manage.py db upgrade
Run python run.py. You may use Postman for Google Chrome to run the API.
| Resource URL | Methods | Description | Requires Token |
|---|---|---|---|
/api/v1/ |
GET | The index | FALSE |
/api/v1/auth/register/ |
POST | User registration | FALSE |
/api/v1/auth/login/ |
POST | User login | FALSE |
/api/v1/bucketlists/ |
GET, POST | A user's bucket lists | TRUE |
/api/v1/bucketlists/<id>/ |
GET, PUT, DELETE | A single bucket list | TRUE |
/api/v1/bucketlists/<id>/items/ |
GET, POST | Items in a bucket list | TRUE |
/api/v1/bucketlists/<id>/items/<item_id>/ |
GET, PUT, DELETE | A single bucket list item | TRUE |
| Method | Description |
|---|---|
| GET | Retrieves a resource(s) |
| POST | Creates a new resource |
| PUT | Updates an existing resource |
| DELETE | Deletes an existing resource |
To register a new user:
To log the user in:
To add a new bucket list (includes the token in the header):
To test, run the following command: nosetests
Copyright (c) 2016 Mbithe Nzomo
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.