Bucketlist API for an online Bucket List service using Flask.
The API offers the following features:
- User log in and register
- Listing, Creating, deleting and updating bucketlists.
- Creating, deleting and updating of bucketlist items.
- Token based authentication for API methods.
- Pagination for GET requests.
- Search by Bucketlist name.
A sample request to create a single bucket list is as follows:
POST /api/v1/bucketlists/ HTTP/1.1
Host: localhost:5000
Content-Type: application/x-www-form-urlencoded
token: eyJhbGciOiJIUzI1NiIsImV4cCI6MzE0NjA2NDUwNjMsImlhdCI6MTQ2MDY0NTA2M30.eyJpZCI6OX0._c2r-kwCAbjV9GSHVV1Vw0k2cSSO1pFbnvfvw38BbFk
Cache-Control: no-cache
Postman-Token: 447971b2-9080-cb19-839e-2e0b82cc29b2
name=MyBucketList
{
"created_by": 1,
"date_created": "2016-04-15 04:12:35",
"date_modified": "2016-04-15 04:12:37",
"id": 26,
"items": [],
"name": "MyBucketList"
}
| Endpoint | Functionality |
|---|---|
| POST /auth/login | Logs a user in |
| POST /auth/register | Register a user |
| POST /bucketlists/ | Create a new bucket list |
| GET /bucketlists/ | List all the created bucketlists |
| GET /bucketlists/ | Get single bucket list |
| PUT /bucketlists/ | Update this bucket list |
| DELETE /bucketlists/ | Delete this single bucket list |
| POST /bucketlists//items/ | Create a new item in bucket list |
| PUT /bucketlists//items/<item_id> | Update a bucket list item |
| DELETE /bucketlists//items/<item_id> | Delete an item in a bucket list |
Clone the repository and do the following from the root folder:
-
Create a virtual environment by running the command
virtualenv env. -
Activate the environment using the command
source env/bin/activate. -
Run
pip install -r requirements.txtto install all relevant dependencies. -
Initialise database migrations by running
python migrate.py db init -
Migrate the database by running
python migrate.py db migrate -
Upgrade by running
python migrate.py db upgrade -
Run the command
python run.pyto start the server. The application will then be live at http://localhost:5000/
In the project root folder, run command nosetests.
This project is built using functionality from the following 3rd party libraries:
The MIT License
Copyright (c) 2016 Jack Mwangi
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.