rodgers31 / backend

backendPotluck Planner API

API Documentation: https://backend-potluck.herokuapp.com/ (UPDATE SO FAR. I have the text document flushed out but endpoints are not available at the moment will flush that out hopefully soon) Users: [GET] /api/users - returns an array filled with user objects similar to the following:

[
  {
        user_id: 1,
        username: "nyriq",
        password: "$2a$08$R//PP9zaFmo5t3RYL4Yh0ONj.68YU2UQ5HlXbt8TbD.WHFMweWCsG",
        name: "nyriq",
        email: "[email protected]"
    },
    {
        user_id: 2,
        username: "huimin",
        password: "$2a$08$6TceWJyijzXrBAQlP.ZsW.o1y1MmmfJaCb3GPlJ.LnC3eYKtiWbzK",
        name: "huimin",
        email: "[email protected]"
    }
]

Authentication:

Method	URL	Description
[POST]	/api/auth/register	Requires a username, password, name, and email. Registers a new user.
[POST]	/api/auth/login	Requires a username and password. Logs the user in.

Users:

Method	URL	Description
[GET]	/api/users/	Returns an array filled with user objects.
[GET]	/api/users/:id	Returns the user object with the specified user_id.
[DELETE]	/api/users/:id	Removes the user with the specified user_id and returns the deleted user.
[PUT]	/api/users/:id	Updates the user with the specified user_id using data from the request body. Returns the modified user

Events:

Method	URL	Description
[POST]	/api/events/	Requires organizer_id, title, date (in the format of mm/dd/yyyy), time (in the format of 03:00), and a location. Returns the event object with the specified event_id.
[GET]	/api/events/	Returns an array filled with event objects.
[GET]	/api/events/:id	Returns the event object with the specified event_id.
[DELETE]	/api/events/:id	Removes the event with the specified event_id and returns the deleted event.
[PUT]	/api/events/:id	Updates the event with the specified event_id using data from the request body. Returns the modified event

Guests:

Method	URL	Description
[GET]	/api/events/:id/guests	Returns an array filled with guests attending the event.
[POST]	/api/events/:id/guests	Requires a user_id and a boolean of attending (true or false). Adds a guest to the event.
[DELETE]	/api/events/:id/guests	Requires user_id Removes the guest with the specified user_id and returns the new list of guests.

Items:

Method	URL	Description
[GET]	/api/events/:id/items	Returns an array filled with items for the event.
[POST]	/api/events/:id/items	Requires an item_name and a name (name of the person bringing the item) and adds the new item to the list of items
[DELETE]	/api/events/:id/items	Requires item_name Removes the item with the specified item_name and returns the new list of items.