API Documentation - alexsmaldone/good-game-guides GitHub Wiki
API Routes
This web app uses the following API routes to dynamically update the page to create a single-page-app-like feel for the user for specific features.
Add and Remove Guides to Shelves
-
A logged in user may update the status of a game guide they are viewing or add it to a custom shelf using a drop-down menu without causing a refresh/redirect.
-
Status Shelves
-
POST /users/:userId/game-guides/:id/status/:id
-
PUT /users/:userId/game-guides/:id/status/:id
-
DELETE /users/:userId/game-guides/:id/status/:id
-
-
Custom Shelves
-
POST /users/:userId/game-guides/:id/custom/:id
-
PUT /users/:userId/game-guides/:id/custom/:id
-
DELETE /users/:userId/game-guides/:id/custom/:id
-
Creating Custom Shelves
-
A logged in user can create a custom shelf dynamically in their "My Game Guides" page. On their "Edit Shelves" page, users can dynamically add, update, and delete their shelves.
-
POST /users/:userId/customShelves
-
PUT /users/:userId/customShelves/:id
-
DELETE /users/:userId/customShelves/:id
-
Ratings
-
A logged in user may update their guide ratings dynamically by clicking the desired number of hearts.
-
POST /reviews/:id/rating
-
PUT /reviews/:id/rating
-