osule / bucket-list-api

BucketList Application API

This is a bucketlist service API built using Flask.

Bucketlist API allows you to manage your own bucketlists.

Features include registering and authenticating a user; creating, retrieving, updating and deleting bucketlist data and bucketlist item data.

###MIME Type The MIME type for requests is always application/json

###EXAMPLE Requests

curl -i -H 'Accept: application/json' 'http://localhost:5000/register'

HTTP/1.0 200 OK
Content-Type: application/json
Content-Length: 159
Server: Werkzeug/0.10.4 Python/2.7.10
Date: Fri, 23 Oct 2015 17:33:15 GMT

{"message": "Welcome to the bucketlist service", "more": "To register make a POST request to /register ENDPOINT with [username] and [password]"}

NOTE THAT upon login, the generated token must be specified in the subsequent request headers. An example of how this looks is:

Authorization: Bearer <token>

###First Things, First You should do an install of all package requirements in your python setup or go about creating a virtual environment.

pip install -r requirements.txt

###Create Database Tables You need to initialize database and tables. The following command does this and also adds a new user with credentials: username john, password oldman

python manager.py createdb -t

###How To Start The Server Run the following command to start the server and begin listening for requests to each endpoints.

python run.py production

You can get available environment options by running:

python run.py -h

###Available Endpoints

Endpoint	Description
POST /auth/login	Login user. Session token is valid for an hour
POST /auth/logout	Logout user.
POST /auth/register	Register user. Request should have username and password in form data.
POST /bucketlists/	Create a new bucket list. Request should have name in form data.
GET /bucketlists/	List all the created bucket lists.
GET /bucketlists/:id	Get single bucket list.
PUT /bucketlists/:id	Update single bucket list. Request should have name in form data.
DELETE /bucketlists/:id	Delete single bucket list.
POST /bucketlists/:id/items	Add a new item to this bucket list. Request should have name, done(defaults to False) in form data.
PUT /bucketlists/:id/items/:item_id	Update this bucket list. Request should have name, done(True or False) in form data.
DELETE /bucketlists/:id/items/:item_id	Delete this single bucket list.
GET /bucketlists?limit=20	Get 20 bucket list records belonging to user. Allows for a maximum of 100 records.
GET /bucketlists?q=bucket1	Search for bucket lists with bucket1 in name.