first commit
This commit is contained in:
gabriellina640
159
.scribe/endpoints/00.yaml
Normal file
159
.scribe/endpoints/00.yaml
Normal file
@@ -0,0 +1,159 @@
|
||||
name: Rankings
|
||||
description: 'APIs para visualização de rankings de jogos'
|
||||
endpoints:
|
||||
-
|
||||
custom: []
|
||||
httpMethods:
|
||||
- GET
|
||||
uri: api/v1/rankings/general
|
||||
metadata:
|
||||
custom: []
|
||||
groupName: Rankings
|
||||
groupDescription: 'APIs para visualização de rankings de jogos'
|
||||
subgroup: ''
|
||||
subgroupDescription: ''
|
||||
title: |-
|
||||
Ranking Geral
|
||||
* Retorna o top 10 jogos baseado no período informado.
|
||||
description: ''
|
||||
authenticated: false
|
||||
deprecated: false
|
||||
headers:
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
urlParameters: []
|
||||
cleanUrlParameters: []
|
||||
queryParameters:
|
||||
period:
|
||||
custom: []
|
||||
name: period
|
||||
description: 'O período do ranking (weekly, monthly, yearly).'
|
||||
required: true
|
||||
example: weekly
|
||||
type: string
|
||||
enumValues: []
|
||||
exampleWasSpecified: true
|
||||
nullable: false
|
||||
deprecated: false
|
||||
cleanQueryParameters:
|
||||
period: weekly
|
||||
bodyParameters: []
|
||||
cleanBodyParameters: []
|
||||
fileParameters: []
|
||||
responses:
|
||||
-
|
||||
custom: []
|
||||
status: 200
|
||||
content: '[{"id":4,"name":"League of Legends","platform":"Riot Launcher","active_players":871182,"weekly_points":973,"monthly_points":1984,"yearly_points":80768,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":12,"name":"Baldur''s Gate 3","platform":"Steam","active_players":1275998,"weekly_points":915,"monthly_points":5889,"yearly_points":52943,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":15,"name":"Stardew Valley","platform":"Steam","active_players":376396,"weekly_points":876,"monthly_points":2187,"yearly_points":35250,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":1,"name":"Counter-Strike 2","platform":"Steam","active_players":929392,"weekly_points":823,"monthly_points":1188,"yearly_points":81765,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":9,"name":"Fortnite","platform":"Epic Games","active_players":1114470,"weekly_points":797,"monthly_points":7803,"yearly_points":40254,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":6,"name":"EA SPORTS FC 24","platform":"Steam","active_players":921786,"weekly_points":696,"monthly_points":3010,"yearly_points":87627,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":3,"name":"Valorant","platform":"Riot Launcher","active_players":870657,"weekly_points":604,"monthly_points":3181,"yearly_points":51833,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":10,"name":"Grand Theft Auto V","platform":"Steam","active_players":219252,"weekly_points":603,"monthly_points":8711,"yearly_points":55435,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":5,"name":"Helldivers 2","platform":"Steam","active_players":740974,"weekly_points":591,"monthly_points":7606,"yearly_points":20462,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":13,"name":"Warzone","platform":"Battle.net","active_players":1362862,"weekly_points":415,"monthly_points":1747,"yearly_points":22846,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"}]'
|
||||
headers:
|
||||
cache-control: 'no-cache, private'
|
||||
content-type: application/json
|
||||
x-ratelimit-limit: '60'
|
||||
x-ratelimit-remaining: '59'
|
||||
access-control-allow-origin: '*'
|
||||
description: null
|
||||
responseFields: []
|
||||
auth: []
|
||||
controller: null
|
||||
method: null
|
||||
route: null
|
||||
-
|
||||
custom: []
|
||||
httpMethods:
|
||||
- GET
|
||||
uri: api/v1/games/most-played
|
||||
metadata:
|
||||
custom: []
|
||||
groupName: Rankings
|
||||
groupDescription: 'APIs para visualização de rankings de jogos'
|
||||
subgroup: ''
|
||||
subgroupDescription: ''
|
||||
title: |-
|
||||
Jogos Mais Jogados
|
||||
* Retorna o top 10 jogos com base no número de jogadores ativos.
|
||||
description: ''
|
||||
authenticated: false
|
||||
deprecated: false
|
||||
headers:
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
urlParameters: []
|
||||
cleanUrlParameters: []
|
||||
queryParameters: []
|
||||
cleanQueryParameters: []
|
||||
bodyParameters: []
|
||||
cleanBodyParameters: []
|
||||
fileParameters: []
|
||||
responses:
|
||||
-
|
||||
custom: []
|
||||
status: 200
|
||||
content: '[{"id":11,"name":"Cyberpunk 2077","platform":"Steam","active_players":1395488,"weekly_points":131,"monthly_points":8565,"yearly_points":96534,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":13,"name":"Warzone","platform":"Battle.net","active_players":1362862,"weekly_points":415,"monthly_points":1747,"yearly_points":22846,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":14,"name":"Apex Legends","platform":"Steam","active_players":1301140,"weekly_points":378,"monthly_points":7466,"yearly_points":49160,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":12,"name":"Baldur''s Gate 3","platform":"Steam","active_players":1275998,"weekly_points":915,"monthly_points":5889,"yearly_points":52943,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":9,"name":"Fortnite","platform":"Epic Games","active_players":1114470,"weekly_points":797,"monthly_points":7803,"yearly_points":40254,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":2,"name":"Elden Ring","platform":"Steam","active_players":1041606,"weekly_points":240,"monthly_points":4402,"yearly_points":77492,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":1,"name":"Counter-Strike 2","platform":"Steam","active_players":929392,"weekly_points":823,"monthly_points":1188,"yearly_points":81765,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":6,"name":"EA SPORTS FC 24","platform":"Steam","active_players":921786,"weekly_points":696,"monthly_points":3010,"yearly_points":87627,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":4,"name":"League of Legends","platform":"Riot Launcher","active_players":871182,"weekly_points":973,"monthly_points":1984,"yearly_points":80768,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":3,"name":"Valorant","platform":"Riot Launcher","active_players":870657,"weekly_points":604,"monthly_points":3181,"yearly_points":51833,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"}]'
|
||||
headers:
|
||||
cache-control: 'no-cache, private'
|
||||
content-type: application/json
|
||||
x-ratelimit-limit: '60'
|
||||
x-ratelimit-remaining: '58'
|
||||
access-control-allow-origin: '*'
|
||||
description: null
|
||||
responseFields: []
|
||||
auth: []
|
||||
controller: null
|
||||
method: null
|
||||
route: null
|
||||
-
|
||||
custom: []
|
||||
httpMethods:
|
||||
- GET
|
||||
uri: 'api/v1/rankings/platforms/{platform}'
|
||||
metadata:
|
||||
custom: []
|
||||
groupName: Rankings
|
||||
groupDescription: 'APIs para visualização de rankings de jogos'
|
||||
subgroup: ''
|
||||
subgroupDescription: ''
|
||||
title: |-
|
||||
Ranking por Plataforma
|
||||
* Retorna os jogos mais bem ranqueados de uma plataforma específica.
|
||||
description: ''
|
||||
authenticated: false
|
||||
deprecated: false
|
||||
headers:
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
urlParameters:
|
||||
platform:
|
||||
custom: []
|
||||
name: platform
|
||||
description: 'O nome da plataforma.'
|
||||
required: true
|
||||
example: Steam
|
||||
type: string
|
||||
enumValues: []
|
||||
exampleWasSpecified: true
|
||||
nullable: false
|
||||
deprecated: false
|
||||
cleanUrlParameters:
|
||||
platform: Steam
|
||||
queryParameters: []
|
||||
cleanQueryParameters: []
|
||||
bodyParameters: []
|
||||
cleanBodyParameters: []
|
||||
fileParameters: []
|
||||
responses:
|
||||
-
|
||||
custom: []
|
||||
status: 200
|
||||
content: '[{"id":11,"name":"Cyberpunk 2077","platform":"Steam","active_players":1395488,"weekly_points":131,"monthly_points":8565,"yearly_points":96534,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":14,"name":"Apex Legends","platform":"Steam","active_players":1301140,"weekly_points":378,"monthly_points":7466,"yearly_points":49160,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":12,"name":"Baldur''s Gate 3","platform":"Steam","active_players":1275998,"weekly_points":915,"monthly_points":5889,"yearly_points":52943,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":2,"name":"Elden Ring","platform":"Steam","active_players":1041606,"weekly_points":240,"monthly_points":4402,"yearly_points":77492,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":1,"name":"Counter-Strike 2","platform":"Steam","active_players":929392,"weekly_points":823,"monthly_points":1188,"yearly_points":81765,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":6,"name":"EA SPORTS FC 24","platform":"Steam","active_players":921786,"weekly_points":696,"monthly_points":3010,"yearly_points":87627,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":5,"name":"Helldivers 2","platform":"Steam","active_players":740974,"weekly_points":591,"monthly_points":7606,"yearly_points":20462,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":15,"name":"Stardew Valley","platform":"Steam","active_players":376396,"weekly_points":876,"monthly_points":2187,"yearly_points":35250,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"},{"id":10,"name":"Grand Theft Auto V","platform":"Steam","active_players":219252,"weekly_points":603,"monthly_points":8711,"yearly_points":55435,"created_at":"2026-04-14T02:35:43.000000Z","updated_at":"2026-04-14T02:35:43.000000Z"}]'
|
||||
headers:
|
||||
cache-control: 'no-cache, private'
|
||||
content-type: application/json
|
||||
x-ratelimit-limit: '60'
|
||||
x-ratelimit-remaining: '57'
|
||||
access-control-allow-origin: '*'
|
||||
description: null
|
||||
responseFields: []
|
||||
auth: []
|
||||
controller: null
|
||||
method: null
|
||||
route: null
|
||||
53
.scribe/endpoints/custom.0.yaml
Normal file
53
.scribe/endpoints/custom.0.yaml
Normal file
@@ -0,0 +1,53 @@
|
||||
# To include an endpoint that isn't a part of your Laravel app (or belongs to a vendor package),
|
||||
# you can define it in a custom.*.yaml file, like this one.
|
||||
# Each custom file should contain an array of endpoints. Here's an example:
|
||||
# See https://scribe.knuckles.wtf/laravel/documenting/custom-endpoints#extra-sorting-groups-in-custom-endpoint-files for more options
|
||||
|
||||
#- httpMethods:
|
||||
# - POST
|
||||
# uri: api/doSomething/{param}
|
||||
# metadata:
|
||||
# groupName: The group the endpoint belongs to. Can be a new group or an existing group.
|
||||
# groupDescription: A description for the group. You don't need to set this for every endpoint; once is enough.
|
||||
# subgroup: You can add a subgroup, too.
|
||||
# title: Do something
|
||||
# description: 'This endpoint allows you to do something.'
|
||||
# authenticated: false
|
||||
# headers:
|
||||
# Content-Type: application/json
|
||||
# Accept: application/json
|
||||
# urlParameters:
|
||||
# param:
|
||||
# name: param
|
||||
# description: A URL param for no reason.
|
||||
# required: true
|
||||
# example: 2
|
||||
# type: integer
|
||||
# queryParameters:
|
||||
# speed:
|
||||
# name: speed
|
||||
# description: How fast the thing should be done. Can be `slow` or `fast`.
|
||||
# required: false
|
||||
# example: fast
|
||||
# type: string
|
||||
# bodyParameters:
|
||||
# something:
|
||||
# name: something
|
||||
# description: The things we should do.
|
||||
# required: true
|
||||
# example:
|
||||
# - string 1
|
||||
# - string 2
|
||||
# type: 'string[]'
|
||||
# responses:
|
||||
# - status: 200
|
||||
# description: 'When the thing was done smoothly.'
|
||||
# content: # Your response content can be an object, an array, a string or empty.
|
||||
# {
|
||||
# "hey": "ho ho ho"
|
||||
# }
|
||||
# responseFields:
|
||||
# hey:
|
||||
# name: hey
|
||||
# description: Who knows?
|
||||
# type: string # This is optional
|
||||
Reference in New Issue
Block a user