Ladyb BucketList API
Rails API for a bucket list service.
Bucketlist API is an API that allows consumers to signup, create bucketlists and add items to their lists.
It can be tested on Apiary ( http://docs.ladybbucketlist.apiary.io/# )
This API was done by Miss Blessing Ebowe as part of the Andela program requirements.
Description
- This is an API which can be used by a consumer to create Bucket lists to which he can add Items.
- To access this service the API consumer has to have signed up and log in, where he gets a token valid for 24 hours after which he has to log in again.
- CRUD operations can be carried out on the bucket list and an item within a bucket list.
Features
Various EndPoints are available for this API see below.
| EndPoint | Functionality |
|---|---|
| POST /auth/login | Logs a user in |
| GET /auth/logout | Logs a user out |
| POST /bucketlists/ | Create a new bucket list |
| GET /bucketlists/ | List all the created bucket lists |
| GET /bucketlists/<id> | Get single bucket list |
| PUT /bucketlists/ | Update this bucket list |
| DELETE /bucketlists/<id> | Delete this single bucket list |
| POST /bucketlists/<id>/items/ | Create a new item in bucket list |
| PUT /bucketlists/<id>/items/<item_id> | Update a bucket list item |
| DELETE /bucketlists/<id>/items/<item_id> | Delete an item in a bucket list |
For complete API documentation visit ( http://docs.ladybbucketlist.apiary.io )
Contributing
- Fork it ( https://github.com/[andela-bebowe]/ladyb_bucketlist/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request.
Development Dependencies
- This API was built using rails-api.
- JWT using ruby-jwt gem for token authentication
- rack-cors gem for Cross Origin Resource Sharing setup
- RSpec for testing.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent