Skip to content

API Documentation

Luke-Yamasaki edited this page Mar 7, 2022 · 5 revisions

Shuttr employs the following backend API routes to listen to the React/Redux frontend requests.

Session

The session route handles restoring the session user, logging in, and logging out.

  • POST /api/session
  • GET /api/session
  • DELETE /api/session

Users

The users route handles signing up, retrieving all users, searching for users, editing user info, and deleting a user.

  • POST /api/users
  • GET /api/users
  • GET /api/users/:userId
  • PUT /api/users/:userId
  • DELETE /api/users/:userId

Images

The images route handles uploading an image, retrieving all images, searching for images, editing images, and deleting images.

  • POST /api/images
  • GET /api/images
  • GET /api/images/:imageId
  • PUT /api/images/:imageId
  • DELETE /api/images/:imageId

Comments

The comments route handles posting a comment, retrieving all comments, searching for a comment, editing comments, and deleting comments.

  • POST /api/comments
  • GET /api/comments
  • GET /api/comments/:commentId
  • PUT /api/comments/:commentId
  • DELETE /api/comments/:commentId

Tags

The tags route handles retrieving all tags, searching for a tag, and deleting tags.

  • POST /api/images *The only way to create a new tag is to upload a photo and type a unique tag name.
  • GET /api/tags
  • GET /api/tags/:tagId
  • DELETE /api/tags/:tagId
Clone this wiki locally