Skip to content

daniel-waiguru/notes-backend-api

Repository files navigation

Build Status License

Notie Server is a backend REST API build with laravel framework and PostgreSQL database deployed on heroku.
BASE_URL = https://notieserver.herokuapp.com/

Headers

"Content-Type": "application/json"
"Accept": "application/json"
"Authorization": "your-issued-token"

Notie-Server EndPoints

Authentication

User registration

POST https://notieserver.herokuapp.com/api/user/register
{
    "name": "Your Name",
    "email": "example@email.com",
    "password": "your_preferred_password"
}

User login

POST https://notieserver.herokuapp.com/api/user/login
{
    "email": "your_registered_email@email.com",
    "password": "your_password"
}

User logout

POST https://notieserver.herokuapp.com/api/user/logout
Authorization: Bearer YOUR_ISSUED_TOKEN

Get User details

GET https://notieserver.herokuapp.com/api/user
Authorization: Bearer YOUR_ISSUED_TOKEN

Notes

Create a Note

To create a note submit a POST request with note title, note_text(description) and Authorization Bearer Token to the follwing endpoint

POST https://notieserver.herokuapp.com/api/note
{
    "note_title": "Your note title",
    "note_text": "Your note description"
}

Edit Note

PUT https://notieserver.herokuapp.com/api/note/{id}
Authorization: Bearer YOUR_ISSUED_TOKEN
{
    "note_title": "Updated note title",
    "note_text": "Updated note description"
}

Get LoggedIn User Notes list

GET https://notieserver.herokuapp.com/api/note
Authorization: Bearer YOUR_ISSUED_TOKEN

Get particular Note Details

GET http://notieserver.herokuapp.com/api/note/{id}
Authorization: Bearer YOUR_ISSUED_TOKEN

Delete a Note

DELETE https://notieserver.herokuapp.com/api/note/{id}
Authorization: Bearer YOUR_ISSUED_TOKEN

Contributing

If you happen find a missing feature or a bug, please feel free to open an issue or pull request

Releases

No releases published

Packages

No packages published

Languages