This is an API for a bucket list designed using spring boot
You should have git, Java JDK, maven, postgresql, intellij installed
- Open your terminal
- Clone the project using
git clone https://github.com/malmike/springbootbucketlistapi
- Run
createdb bucketlist_api_dev
andcreate test_db
- Change to the project directory using
cd springbootbucketlistapi
- Open intellij IDE and import the project
- Install packages by right clicking on the project, go to
Maven
option in menu then clickReImport
orDownload Sources and Documentation
option in sub menu.
EndPoint | Functionality | Public Access |
---|---|---|
POST /auth/login | Logs a user in | FALSE |
POST /auth/register | Register a user | FALSE |
POST /auth/logout | Logs a user out | TRUE |
POST /bucketlists/ | Create a new bucket list | TRUE |
GET /bucketlists/ | List all the created bucket lists | TRUE |
GET /bucketlists/<id> | Get single bucket list | TRUE |
PUT /bucketlists/<id> | Update this bucket list | TRUE |
DELETE /bucketlists/<id> | Delete this single bucket list | TRUE |
POST /bucketlists/<id>/items/ | Create a new item in bucket list | TRUE |
PUT /bucketlists/<id>/items/<item_id> | Update a bucket list item | TRUE |
DELETE /bucketlists/<id>/items/<item_id> | Delete an item in a bucket list | TRUE |
GET /bucketlists?limit=<number> | Gets a number of bucket lists relative to the value passed in number. Maximum records is 100 | TRUE |
GET /bucketlists?q=<bucketlist_name> | Search for bucket list with the same name as that passed in bucketlist_name | TRUE |