Skip to content

Backend Routes

James Hawkins edited this page Feb 27, 2019 · 4 revisions

Backend Routes

HTML

  • GET / StaticPagesController#root

API Endpoints

users

  • GET /api/users
    • Returns id, full_name, email of each User for User Lookup
  • POST /api/users
    • New user sign up

session

  • POST /api/session
    • Log in
  • DELETE /api/session
    • Log out

chatrooms

  • GET /api/chatrooms
    • Returns relevant chatrooms (filtered by given params)
  • GET /api/chatrooms/:id
    • Returns details about an individual chatroom

messages

  • GET /api/messages
    • Returns all relevant messages (filtered by given params)
  • POST /api/messages
    • Adds message to chatroom
  • GET /api/chatrooms/:id/messages
    • Returns all messages for an individual chatroom
  • GET /api/messages/:id
    • Returns details about a specific message
  • PATCH /api/messages/:id
    • Edits a specific message
  • DELETE /api/messages/:id
    • Deletes message from chatroom

stars

  • POST /api/stars
    • Stars a message or a chatroom
  • DELETE /api/stars/:id
    • Remove a star from a chatroom or message

pinnedMessages

  • POST /api/pinned_messages
    • Pins a message to a chatroom (filtered by given params)
  • DELETE /api/pinned_messages/:id
    • Remove a pinned message from a chatroom

reactions

  • POST /api/reactions
    • Adds a reaction to a message
  • DELETE /api/reactions/:id
    • Removes a reaction from a message
Note: stars, pinnedMessages, and reactions don't have their own GET routes as this information is returned through the api calls for users, chatrooms, and messages, respectively. This can be seen in the Sample State