document.yaml

{
  'openapi': '3.0.0',
  'info':
    {
      'title': 'Game API',
      'version': '1.0.0',
      'description': 'API Documentation for Game Backend',
      'contact': { 'name': 'Amazing Developer' },
    },
  'tags': [{ 'name': 'Game', 'description': 'Operations related to games' }],
  'paths':
    {
      '/api/banner':
        {
          'get':
            {
              'summary': 'Get Banner',
              'tags': ['Game'],
              'description': 'Retrieve the banner.',
              'responses':
                {
                  '200': { 'description': 'Successful operation' },
                  '400': { 'description': 'Bad Request' },
                  '404': { 'description': 'Not Found' },
                  '500': { 'description': 'Internal Server Error' },
                },
            },
        },
      '/api/game':
        {
          'post':
            {
              'summary': 'Create a new game',
              'tags': ['Game'],
              'description': 'Create a new game with the provided details',
              'requestBody':
                {
                  'required': true,
                  'content':
                    {
                      'application/json':
                        {
                          'schema':
                            {
                              'type': 'object',
                              'properties':
                                {
                                  'name': { 'type': 'string' },
                                  'description': { 'type': 'string' },
                                  'genre':
                                    {
                                      'type': 'array',
                                      'items': { 'type': 'string' },
                                      'enum':
                                        [
                                          'action',
                                          'adventure',
                                          'fps',
                                          'tps',
                                          'rpg',
                                          'strategy',
                                          'simulation',
                                          'sports',
                                          'racing',
                                          'horror',
                                          'fantasy',
                                          'sci-fi',
                                          'arcade',
                                          'interactive-fiction',
                                          'building-construction',
                                        ],
                                    },
                                  'platform':
                                    {
                                      'type': 'array',
                                      'items': { 'type': 'string' },
                                      'enum':
                                        [
                                          'playstation',
                                          'pc',
                                          'xbox',
                                          'steam',
                                          'android',
                                          'ios',
                                          'nintendo',
                                          'epicgamesstore',
                                        ],
                                    },
                                  'bannerImage':
                                    { 'type': 'string', 'format': 'uri' },
                                  'story':
                                    {
                                      'type': 'array',
                                      'items':
                                        {
                                          'type': 'object',
                                          'properties':
                                            {
                                              'title': { 'type': 'string' },
                                              'description':
                                                { 'type': 'string' },
                                              'image':
                                                {
                                                  'type': 'string',
                                                  'format': 'uri',
                                                },
                                            },
                                        },
                                    },
                                  'score':
                                    {
                                      'type': 'number',
                                      'minimum': 0,
                                      'maximum': 5,
                                    },
                                  'trailer':
                                    {
                                      'type': 'object',
                                      'properties':
                                        {
                                          'poster':
                                            {
                                              'type': 'string',
                                              'format': 'uri',
                                            },
                                          'url':
                                            {
                                              'type': 'string',
                                              'format': 'uri',
                                            },
                                        },
                                    },
                                  'releaseYear':
                                    { 'type': 'string', 'format': 'date-time' },
                                },
                            },
                        },
                    },
                },
              'responses':
                {
                  '201': { 'description': 'Game created successfully' },
                  '400': { 'description': 'Bad Request' },
                  '500': { 'description': 'Internal Server Error' },
                },
            },
          'get':
            {
              'summary': 'Get All Games',
              'tags': ['Game'],
              'description': 'Retrieve the list of games based on platform and genre.',
              'parameters':
                [
                  {
                    'name': 'platform',
                    'in': 'query',
                    'schema':
                      {
                        'type': 'string',
                        'enum':
                          [
                            'playstation',
                            'xbox',
                            'steam',
                            'pc',
                            'android',
                            'ios',
                            'nintendo',
                            'epicgamesstore',
                          ],
                      },
                    'description': 'The platform of the games.',
                  },
                  {
                    'name': 'genre',
                    'in': 'query',
                    'schema':
                      {
                        'type': 'string',
                        'enum':
                          [
                            'action',
                            'adventure',
                            'fps',
                            'tps',
                            'rpg',
                            'strategy',
                            'simulation',
                            'sports',
                            'racing',
                            'horror',
                            'fantasy',
                            'sci-fi',
                            'arcade',
                            'interactive-fiction',
                            'building-construction',
                          ],
                      },
                    'description': 'The genre of the games.',
                  },
                ],
              'responses':
                {
                  '200': { 'description': 'Successful operation' },
                  '400': { 'description': 'Bad Request' },
                  '404': { 'description': 'Not Found' },
                  '500': { 'description': 'Internal Server Error' },
                },
            },
        },
      '/api/game/{gameId}':
        {
          'get':
            {
              'summary': 'Get Game Detail',
              'tags': ['Game'],
              'description': 'Retrieve the details of a specific game by its ID.',
              'parameters':
                [
                  {
                    'name': 'gameId',
                    'in': 'path',
                    'description': 'The unique identifier of the game.',
                    'required': true,
                    'schema': { 'type': 'string' },
                  },
                ],
              'responses':
                {
                  '200': { 'description': 'Successful operation' },
                  '400': { 'description': 'Bad Request' },
                  '404': { 'description': 'Not Found' },
                  '500': { 'description': 'Internal Server Error' },
                },
            },
          'delete':
            {
              'summary': 'Delete a game',
              'tags': ['Game'],
              'description': "Delete a game by its unique ID (`gameId`).\n\n`gameId`:\n- Type: string\n- In: path\n- Description: The unique identifier of the game.",
              'parameters':
                [
                  {
                    'name': 'gameId',
                    'in': 'path',
                    'description': 'The unique identifier of the game.',
                    'required': true,
                    'schema': { 'type': 'string' },
                  },
                ],
              'responses':
                {
                  '204': { 'description': 'Game deleted successfully' },
                  '404': { 'description': 'Game not found' },
                  '500': { 'description': 'Internal Server Error' },
                },
            },
        },
      '/api/gameLanding':
        {
          'get':
            {
              'summary': 'Get gameLanding',
              'tags': ['Game'],
              'description': 'Retrieve the landing page images.',
              'responses':
                {
                  '200': { 'description': 'Successful operation' },
                  '400': { 'description': 'Bad Request' },
                  '404': { 'description': 'Not Found' },
                  '500': { 'description': 'Internal Server Error' },
                },
            },
          'post':
            {
              'summary': 'Create a gameLanding',
              'tags': ['Game'],
              'description': 'Create a gameLanding with the provided details',
              'requestBody':
                {
                  'required': true,
                  'content':
                    {
                      'application/json':
                        {
                          'schema':
                            {
                              'type': 'object',
                              'properties':
                                {
                                  'platform': { 'type': 'string' },
                                  'description': { 'type': 'string' },
                                  'image':
                                    { 'type': 'string', 'format': 'uri' },
                                },
                              'required': ['platform', 'description', 'image'],
                            },
                        },
                    },
                },
              'responses':
                {
                  '201': { 'description': 'GameLanding created successfully' },
                  '400': { 'description': 'Bad Request' },
                  '500': { 'description': 'Internal Server Error' },
                },
            },
        },
      '/api/gameLanding/{gameLandingId}':
        {
          'delete':
            {
              'summary': 'Delete a gameLanding',
              'tags': ['Game'],
              'description': 'Delete a gameLanding by its unique ID (`gameLandingId`).',
              'parameters':
                [
                  {
                    'name': 'gameLandingId',
                    'in': 'path',
                    'description': 'The unique identifier of the gameLanding.',
                    'required': true,
                    'schema': { 'type': 'string' },
                  },
                ],
              'responses':
                {
                  '204': { 'description': 'GameLanding deleted successfully' },
                  '404': { 'description': 'GameLanding not found' },
                  '500': { 'description': 'Internal Server Error' },
                },
            },
        },
      '/api/genre':
        {
          'get':
            {
              'summary': 'Get genre',
              'tags': ['Game'],
              'description': 'Retrieve the list of game genres.',
              'responses':
                {
                  '200': { 'description': 'Successful operation' },
                  '400': { 'description': 'Bad Request' },
                  '404': { 'description': 'Not Found' },
                  '500': { 'description': 'Internal Server Error' },
                },
            },
        },
      '/api/platform':
        {
          'get':
            {
              'summary': 'Get platform',
              'tags': ['Game'],
              'description': 'Retrieve the list of game platforms.',
              'responses':
                {
                  '200': { 'description': 'Successful operation' },
                  '400': { 'description': 'Bad Request' },
                  '404': { 'description': 'Not Found' },
                  '500': { 'description': 'Internal Server Error' },
                },
            },
        },
      '/api/randomGame':
        {
          'get':
            {
              'summary': 'Get randomGame for slider',
              'tags': ['Game'],
              'description': 'Retrieve a random game for use in a slider.',
              'responses':
                {
                  '200': { 'description': 'Successful operation' },
                  '400': { 'description': 'Bad Request' },
                  '404': { 'description': 'Not Found' },
                  '500': { 'description': 'Internal Server Error' },
                },
            },
        },
      '/api/topGames':
        {
          'post':
            {
              'summary': 'Create a new top game for a specific year',
              'tags': ['Game'],
              'description': 'Creates a new top game entry for the specified year.',
              'parameters':
                [
                  {
                    'name': 'year',
                    'in': 'path',
                    'description': 'The year of the top games (e.g., 2021, 2022, 2023, ...)',
                    'required': true,
                    'schema': { 'type': 'integer', 'minimum': 2021 },
                  },
                  {
                    'name': 'game_data',
                    'in': 'body',
                    'description': 'The JSON object containing information about the game',
                    'required': true,
                    'schema':
                      {
                        'type': 'object',
                        'properties':
                          {
                            'name': { 'type': 'string' },
                            'description': { 'type': 'string' },
                            'bannerImage': { 'type': 'string' },
                            'builder':
                              {
                                'type': 'array',
                                'items': { 'type': 'string' },
                              },
                            'platform':
                              {
                                'type': 'array',
                                'items': { 'type': 'string' },
                              },
                            'releaseYear':
                              { 'type': 'string', 'format': 'date-time' },
                          },
                      },
                  },
                ],
              'responses':
                {
                  '201': { 'description': 'Game created successfully' },
                  '400': { 'description': 'Bad Request' },
                  '500': { 'description': 'Internal Server Error' },
                },
            },
        },
      '/api/topGames/{year}':
        {
          'get':
            {
              'summary': 'Get topGames for a specific year',
              'tags': ['Game'],
              'description': 'Returns the top games for the specified year.',
              'parameters':
                [
                  {
                    'name': 'year',
                    'in': 'path',
                    'description': 'The year of the top games (e.g., 2021, 2022, 2023, ...)',
                    'required': true,
                    'schema': { 'type': 'integer', 'minimum': 2021 },
                  },
                ],
              'responses':
                {
                  '200': { 'description': 'Successful operation' },
                  '400': { 'description': 'Bad Request' },
                  '404': { 'description': 'Not Found' },
                  '500': { 'description': 'Internal Server Error' },
                },
            },
        },
    },
  'components':
    {
      'schemas':
        {
          'Game Query Params':
            {
              'type': 'object',
              'properties':
                {
                  'platform':
                    {
                      'type': 'string',
                      'enum':
                        [
                          'playstation',
                          'xbox',
                          'steam',
                          'pc',
                          'android',
                          'ios',
                          'nintendo',
                          'epicgamesstore',
                        ],
                    },
                  'genre':
                    {
                      'type': 'string',
                      'enum':
                        [
                          'action',
                          'adventure',
                          'fps',
                          'tps',
                          'rpg',
                          'strategy',
                          'simulation',
                          'sports',
                          'racing',
                          'horror',
                          'fantasy',
                          'sci-fi',
                          'arcade',
                          'interactive-fiction',
                          'building-construction',
                        ],
                    },
                },
              'required': ['platform', 'genre'],
            },
          'Year Path Param':
            {
              'type': 'object',
              'properties': { 'year': { 'type': 'integer', 'minimum': 2021 } },
              'required': ['year'],
            },
          'GameId':
            {
              'type': 'string',
              'required': ['gameId'],
              'description': 'The unique identifier of the game.',
            },
        },
    },
}