Skip to content

Backend Routes

Sionar edited this page Mar 5, 2020 · 2 revisions

Backend Routes

HTML

  • GET / StaticPagesController#root

API Endpoints

users

  • GET /api/users/:id - returns the username and info of a user
  • POST /api/users - sign up

session

  • POST /api/session - log in
  • DELETE /api/session - log out

server_keys

  • GET /api/server_keys/:server_key - joins the current user to a server, returns all of the channels on that server, all of the messages for each channel on the server and all of the active users on the server
  • GET /api/servers/:server_id/server_keys - gets a list of all the server keys for a server
  • POST /api/servers/:server_id/server_keys - creates a server key for a server

servers

  • GET /api/servers - retrieves a list of 4 public servers + all servers made by current_user, all of the channels for that server, 50 most recent messages for each channel on that server, and all of the active users on those servers.
  • POST /api/servers - create a server
  • PATCH /api/servers/:server_id - edit a server
  • DELETE /api/servers/:server_id - delete a server

channels

  • POST /api/servers/:server_id/channels - create a channel
  • GET /api/servers/:server_id/channels/:channel_id - gets a channel on a server (when it is created)
  • PATCH /api/servers/:server_id/channels/:channel_id - edit a channel
  • DELETE /api/servers/:server_id/channels/:channel_id - delete a channel

messages

  • POST /api/servers/:server_id/channels/:channel_id/messages - creates a message
  • GET /api/servers/:server_id/channels/:channel_id/messages/:message_id - gets a message
  • PATCH /api/servers/:server_id/channels/:channel_id/messages/:message_id - edits a message
  • DELETE /api/servers/:server_id/channels/:channel_id/messages/:message_id - deletes a message

Clone this wiki locally