This is a video games api that offers information about video games' release statuses, development studios ratings and genres. Please note that the api is for educational purposes only, and so it may contain inaccurate or placeholder data. it is also worth mentioning that this is a work in progress.
Check out the api running live here
If you want to run the app locally on your machine then follow the instructions below
The first thing you will need is Python. You can follow these instructions to install the latest version python docs
Now you need to install the project dependencies, but before you do it's recommended to use a virtual environment in order to separate dependencies of different projects. Take a look at Python's documentation for virual enviornment here python docs
to install the project dependencies you can run the command
pip install -r requirements.txtin the project's root directory. This will install all the required packages from requirements.txt file.
Double click app.py file to start the server. Make sure it's working correctly by navigating to http://localhost:5000
Read the following documentation for the api endpoints if you want to experience with the api.
- GET '/games'
- GET '/games/<certain_game_id>'
- POST '/games'
- PATCH '/games/<certain_game_id>'
- DELETE '/games/<certain_game_id>'
- GET '/developers'
- GET '/developers/<certain_developer_id>'
- GET '/developers/<certain_developer_id>/games'
- POST '/developers'
- GET '/publishers'
- GET '/publishers/<certain_publisher_id>'
- GET '/publishers/<certain_publisher_id>/games'
- POST '/publishers'
- Fetches a list of all games in the api
- Request Arguments: None
- Returns: a list of objects each resembling a video game. Response has the following format:
{
"success": true,
"games": [
{
"id": 1,
"name": "game_1",
"description": "game_1_description",
"release_date": "19/4/22",
"released": false,
"rating": 88,
"critic_rating": 93,
"PEGI_rating": 13,
"genres": "action",
"developer": 1,
"publisher": "21",
},
{
"id": 2,
"name": "game_2",
"description": "game_2_description",
"release_date": "19/4/20",
"released": true,
"rating": 95,
"critic_rating": 100,
"PEGI_rating": 18,
"genres": "action",
"developer": "4",
"publisher": "22",
}
]
}- Fetches the game with
id = certain_game_idor 404 if not found. - Request Arguments: None
- Returns: An object resembling the video game. Response has the following format:
{
"success": true,
"game": {
"id": 1,
"name": "game_1",
"description": "game_1_description",
"release_date": "19/4/22",
"released": false,
"rating": 88,
"critic_rating": 93,
"PEGI_rating": 13,
"genres": "action",
"developer": 1,
"publisher": 7,
}
}- Lets you add a game to the api's list of games.
- Request Arguments: the request must have the following format:
{
"name": "game_1",
"description": "game_1_description",
"release_date": "22/3/21",
"rating": 88,
"critic_rating": 93,
"PEGI_rating": 13,
"genres": "action",
"developer": 7,
"publisher": 14,
}Please note that release_date has the following format d/m/y and developer and publisher is the id of the developer and publisher respectively.
- Returns: if the game was added successfully, the response will have the following format:
{
"success": true,
"game": {
"id": 1,
"name": "game_1",
"description": "game_1_description",
"release_date": "22/3/21",
"rating": 88,
"critic_rating": 93,
"PEGI_rating": 13,
"genres": "action",
"developer": 7,
"publisher": 14,
}
}- Lets you edit a game.
- Request Arguments: the request must have the following format:
{
"name": "game_1",
"description": "game_1_description",
"release_date": "22/3/21",
"rating": 88,
"critic_rating": 93,
"PEGI_rating": 13,
"genres": "action",
"developer": 22,
"publisher": 91,
}Note that all properties in the above request are optional. If you included property name in your request, then the game's name property will be updated.
- Returns: if the request was processed successfully, the response will have the following format:
{
"success": true,
"game": {
"id": 1,
"name": "game_1",
"description": "game_1_description",
"release_date": "22/3/21",
"rating": 88,
"critic_rating": 93,
"PEGI_rating": 13,
"genres": "action",
"developer": 22,
"publisher": 91,
}
}- Deletes the game with the id certain_game_id
- Request arqument: None.
- Returns: if the request was processed successfully, the response will have the following format:
{
"success": true,
"message": "successfully deleted game with id 1",
}- Fetches a list of all developers in the api
- Request Arguments: None
- Returns: a list of objects each resembling a developer. Response has the following format:
{
"success": true,
"developers": [
{
"id": 1,
"name": "developer_1",
"description": "developer_1_description",
"rating": 88,
"establish year": 2002,
"active": true,
}
]
}- Fetches the developer with
id = certain_developer_idor 404 if not found. - Request Arguments: None
- Returns: An object resembling the developer. Response has the following format:
{
"success": true,
"developer": {
"id": 1,
"name": "developer_1",
"description": "developer_1_description",
"rating": 88,
"establish year": 2002,
"active": true,
}
}- Fetches the games that are developed by the developer with
id = certain_developer_id. - Request Arguments: None
- Returns: A list to games. Response has the following format:
{
"success": true,
"games": [
{
"id": 1,
"name": "game_1",
"description": "game_1_description",
"release_date": "19/4/22",
"released": false,
"rating": 88,
"critic_rating": 93,
"PEGI_rating": 13,
"genres": "action",
"developer": 1,
"publisher": "21",
},
{
"id": 2,
"name": "game_2",
"description": "game_2_description",
"release_date": "19/4/20",
"released": true,
"rating": 95,
"critic_rating": 100,
"PEGI_rating": 18,
"genres": "action",
"developer": "1",
"publisher": "77",
}
]
}- Lets you add a developer to the api's list of developers.
- Request Arguments: the request must have the following format:
{
"name": "developer_name",
"description": "developer_description",
"rating": 88,
"establish year": 2002,
"active": true,
}- Returns: if the developer was added successfully, the response will have the following format:
{
"success": true,
"developer": {
"id": 1,
"name": "developer_name",
"description": "developer_description",
"rating": 88,
"establish year": 2002,
"active": true,
}
}- Fetches a list of all publishers in the api
- Request Arguments: None
- Returns: a list of objects each resembling a publisher. Response has the following format:
{
"success": true,
"publishers": [
{
"id": 1,
"name": "publisher_1",
"description": "publisher_1_description",
"rating": 88,
"establish year": 2002,
"active": true,
}
]
}- Fetches the publisher with
id = certain_publisher_idor 404 if not found. - Request Arguments: None
- Returns: An object resembling the publisher. Response has the following format:
{
"success": true,
"publisher": {
"id": 1,
"name": "publisher_1",
"description": "publisher_1_description",
"rating": 88,
"establish year": 2002,
"active": true,
}
}- Fetches the games that are published by the publisher with
id = certain_publisher_id. - Request Arguments: None
- Returns: A list to games. Response has the following format:
{
"success": true,
"games": [
{
"id": 1,
"name": "game_1",
"description": "game_1_description",
"release_date": "19/4/22",
"released": false,
"rating": 88,
"critic_rating": 93,
"PEGI_rating": 13,
"genres": "action",
"developer": 64,
"publisher": "21",
},
{
"id": 2,
"name": "game_2",
"description": "game_2_description",
"release_date": "19/4/20",
"released": true,
"rating": 95,
"critic_rating": 100,
"PEGI_rating": 18,
"genres": "action",
"developer": "117",
"publisher": "21",
}
]
}- Lets you add a publisher to the api's list of publishers.
- Request Arguments: the request must have the following format:
{
"name": "publisher_name",
"description": "publisher_description",
"rating": 88,
"establish year": 2002,
"active": true,
}- Returns: if the publisher was added successfully, the response will have the following format:
{
"success": true,
"publisher": {
"id": 1,
"name": "publisher_name",
"description": "publisher_description",
"rating": 88,
"establish year": 2002,
"active": true,
}
}Some of the endpoints in the api require you to have permissions in order to process your requests. The permissions needed for the api endpoints are:
| endpoint | permission |
|---|---|
| GET '/games' | get:games |
| GET '/games/<certain_game_id>' | get:games |
| POST '/games' | post:games |
| PATCH '/games/<certain_game_id>' | patch:games |
| DELETE '/games/<certain_game_id>' | delete:games |
these permissions are provided as part of the JWT that you include in your request before sending it. To ensure that the JWT gets processed correctly, in your request's headers include this header "Authorization": "Bearer JWT". Replace JWT with the JWT that contains the permissions and do not forget the space.
At the moment the api does not have a front end through which you can create a account and get permissions and JWTs. That's why in access tokens.txt you can find two JWTs that have the permissions needed to interact with the api. The first one is for a guest user and has only the permission to view games in the api. The second is for an admin user and has all permissions.
If you are running the app locally and would like to run the unittest script that contains tests I wrote for the api endpoints to ensure that it's working correctly, then run the following
python test_app.py