So far, our RESTful API has performed CRUD operations on a single database table. Now, we want to create a more complex RESTful API with Django REST Framework to interact with a complex database model that has to allow us to register player scores for played games that are grouped into game categories. In our previous RESTful API, we used a string field to specify the game category for a game. In this case, we want to be able to easily retrieve all the games that belong to a specific game category, and therefore, we will have a relationship between a game and a game category.
We should be able to perform CRUD operations on different related resources and resource collections. The following list enumerates the resources and the model names that we will use to represent them in Django REST Framework:
- Game categories (
GameCategorymodel) - Games (
Gamemodel) - Players (
Playermodel) - Player scores (
PlayerScoremodel)
The game category (GameCategory) just requires a name, and we need the following data for a game (Game):
- A foreign key to a game category (
GameCategory) - A name
- A release date
- A bool value indicating whether the game was played at least once by a player or not
- A timestamp with the date and time in which the game was inserted in the database
We need the following data for a player (Player):
- A gender value
- A name
- A timestamp with the date and time in which the player was inserted in the database
We need the following data for the score achieved by a player (PlayerScore):
- A foreign key to a player (
Player) - A foreign key to a game (
Game) - A score value
- A date in which the score value was achieved by the player
Tip
We will take advantage of all the resources and their relationships to analyze different options that Django REST Framework provides us when working with related resources. Instead of building an API that uses the same configuration to display related resources, we will use diverse configurations that will allow us to select the most appropriate options based on the particular requirements of the APIs that we are developing.