API Documentation for Practice App Esport Tournaments

Esport Tournaments - POST

• Endpoint: /api/v1/games/tournaments
• Definition: Requests the data for the esport tournaments from a third party API and inserts them into the database.
• Query Parameters: None
• Body Data: userEmail:string (required)
• Example Request Query:

http://localhost:3001/api/v1/games/tournaments

• Example Request Body:

{
    "userEmail":"[email protected]"
}

• Example Response Body:

{
    "status": "success",
    "message": "tournaments for esports are inserted to database successfully"
}

Esport Tournaments - GET

• Endpoint: /api/v1/games/tournaments
• Definition: Returns the esport tournaments that are added to the database for the user with email as userEmail
• Query Parameters: userEmail: string (required)
• Body Data: None
• Example Request Query:

http://localhost:3001/api/v1/games/[email protected]

• Example Request Body: None
• Example Response Body:

[
    {
        "user_email": "[email protected]",
        "id": 1570,
        "name": "Dota 2",
        "flag": "dota-2",
        "createdAt": "2023-05-12T13:21:58.550Z"
    },
    {
        "user_email": "[email protected]",
        "id": 1572,
        "name": "CS:GO",
        "flag": "csgo",
        "createdAt": "2023-05-12T13:21:58.550Z"
    },
]