Analyzing the requirements of the best league table API you've ever seen

Let's start by writing what the idea is: receiving a set of teams and returning the table with all the games between these teams, the dates of the matches and our "optimization", which aims to reduce the number of trips between teams.

Considering the output, we need to have as input not only the team name, but other data as well:

• your location, so we can plan trips;
• the championship model: will they be teams in a single group, like the Brasileirão? Or will they be teams divided into several groups, like the World Cup?
• will the championship be round and round, a single round, or some mixed model, like the Champions League, where despite a single group, everyone doesn't play against everyone?
• if there is a division into groups, are we the ones who will draw which team falls into each group or has the user already defined this? Let's give the option to the user;
• does the user really want an "optimized" table?. Maybe it's just the condominium championship, right? Let's offer the user the option of creating a simple table or an optimized one, ok?
• how many games can we schedule per day?

• and what is the rest interval that a team needs to have between one match and another?

• And the name of the championship, of course.

Note: At this stage, in a real project, we would have to obtain these requirements from the customer.

Given the information above, we can infer that our system inputs will be:

Entries:

• A set of teams and their locations
• the form of the championship (how many rounds will there be between teams from the same group? And against teams from other groups? In fact, will there be division into groups?
• If there is division into groups, are we the ones who will do the draw or will we receive the groups already defined?
• Does the user want an optimized table? Yes or no?
• Total games allowed per day
• Rest days that a team;needs to have between one game and another;
• And the name of the championship.

And the output will be:

• The name of the championship
• The groups (or the group, if it is just one)
• The games table, containing all games with their respective dates

Here you can imagine two JSONs, one with the input data and the other with the output data, right?

And, for each topic, you can already imagine an object, ok?

And since objects always lead us to talk about classes, we are already very close to it... The code.

Subjects for the next text. We continue.

The above is the detailed content of Analyzing the requirements of the best league table API you've ever seen. For more information, please follow other related articles on the PHP Chinese website!