brotich / cp2-bucket-list-api Goto Github PK

This API enables the user to create bucketlist and list of items in the bucketlist. The items can be marked as done when completed.

1. create a working directory

      $ mkdir -p work-dir
      $ cd workdir
   

2. clone this repo to local

   • Via SSH

     	git clone [email protected]:brotich/CP2-bucket-list-api.git
     

   • via HTTPS

     	git clone https://github.com/brotich/CP2-bucket-list-api.git
     

3. Navigate to project directory

    	$ cd CP2-bucket-list-api
    	$ git checkout develop
   

4. (Recommended)Create virtual environment

    $ virtualenv bucketlist-venv
    $ source bucketlist-venv/bin/activate
   

5. Set up the development environment for the project

      $ pip install -r requirements.txt
      $ python manage.py db init 
      $ python manage.py db migrate 
      $ python manage.py db upgrade
   

6. run server

   	$ python run.py 
      Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)
   

   The API server is accessible on http://0.0.0.0:5000/

Access the endpoints using your preferred client e.g Postman

• POST http://0.0.0.0:5000/auth/login/ register new user providing username and password

  body:

  username: brian2
  password: password
  

  response:

    {
        "message": "new user created successfully",
        "username": "brian2"
    }
  

• POST http://0.0.0.0:5000/auth/login/ login a user and get the token body:

   username: brian2
   password: password
  

  response:

    {
   	"message": "new user created successfully",
   	"username": "brian2"
    }
  

• POST http://localhost:5000/bucketlists/ create a new bucket list

  headers:

   	Authorization: Token brian2.C1Y5JA.fXefAieGzWOviHlh3lYYLJphk98
  

  body:

    bucket_name: Christmas
  

  response:

     {
      "data": {
        "created_by": 1,
        "date_created": "Tue, 10 Jan 2017 10:17:41 GMT",
        "date_modified": "Tue, 10 Jan 2017 10:17:41 GMT",
        "id": 1,
        "name": "Christmas"
      }
      }
  

• GET http://localhost:5000/bucketlists/ gets bucketlist for the user with the token supplied

  headers:

   	Authorization: Token brian2.C1Y5JA.fXefAieGzWOviHlh3lYYLJphk98
  

  response:

    {
      "data": [
    	    {
    	      "created_by": 1,
    	      "date_created": "Tue, 10 Jan 2017 10:17:41 GMT",
    	      "date_modified": "Tue, 10 Jan 2017 10:17:41 GMT",
    	      "id": 1,
    	      "name": "Christmas"
    	    }
    	  ],
       "next": null,
       "prev": null
    }