Version: en
Overview
User Data Schema
All Gameo users will create an account, which is stored in a database cloud sevice called MongoDB Atlas. A typical user in Gameo will have the following data stored:
| Property | Type | Description | Example |
|---|---|---|---|
| _id | Object | Automatically generated by MongoDB | {$oid: "5f7a2df58b5ab52efb5d55d4"} |
| name | String | User's name under account | John Doe |
| String | User's email registered with account | johndoe@example.com | |
| games | Array | List of games user has played and added to library | [{game_id: 4291, rating: "9", title: "Counter-Strike: Global Offensive"}, {game_id: 23598, rating: "10", title: "League of Legends"}] |
| wishlist | Array | List of games user has added to their wishlist | Same as above |
Endpoints
Endpoints enables user interaction with the MongoDB Atlas database in order to constantly update their game preferences and store new games that they have added to their library or wishlist.
PyMongo is the Python wrapper for MongoDB to work in Python. See their official documentation here.
| Method | Endpoint | Description | Tutorial |
|---|---|---|---|
| POST | /user | Creates a new user | Create User |
| GET | /user | Gets a user | Get User |
| GET | /game | Gets game recommendations | Get Recommendations |
| PATCH | /game | Adds a game to user's game library or wishlist | Add Game |
| PATCH | /remove | Removes a game from user's game library or wishlist | Remove Game |
| PATCH | /rate | Updates user's rating for a game | Rate Game |