API_DOCS.md

API Reference

• Register
• Authenticate User
• Journals
  • Get All Journals of a User
  • Add a new Journal
  • Edit a Journal
  • Delete a Journal
• Share Journals
  • Display all journals shared with a user
  • Share your journal with a friend
• Bookmark your Favorite Journal

---

Register

  POST /api/users

Request	Access	Description
POST	Public	Register a user

Authenticate User

 POST  /api/auth

Request	Access	Description
POST	Public	Authenticate user and get token

  GET  /api/auth

Request	Access	Description
GET	Private	Get logged in user

Journals

• Get All Journals of a User

  GET /api/journals

Request	Access	Description
GET	Private	Get all Journals of a logged in user

• Add a new Journal

  POST /api/journals

Request	Access	Description
POST	Private	Add a new journal

• Edit a Journal

  PUT /api/journals/:id

Request	Access	Params	Description
PUT	Private	id	Edit a journal specified by its id

• Delete a Journal

  DELETE /api/journals/:id

Request	Access	Params	Description
DELETE	Private	id	Delete a journal specified by its id

Share Journals

• Display all journals shared with a user

  GET  /api/journals/share/

Request	Access	Description
GET	Private	Get all journals shared with the user

• Share your journal with a friend

  POST /api/journals/share/:id

Request	Access	Params	Description
POST	Private	id	Share a journal specified by its id to a registered user via email (Required: Email of the user to share with)

Bookmark your Favorite Journal

  PUT /api/journals/favorites/:id

Request	Access	Params	Description
PUT	Private	id	Mark/Unmark your journals as favorites