Exemplo de API RESTful para gestão de games.
(Está API não foi feita para ter uma utilidade real, o obejtivo era entender o processo de criação e consumo de uma API.)
Responsável por gerar Token de autenticação.
email: email cadastrado no sistema.
password: senha cadastrada no sistema, referente ao email.
{
"email": "felipefclariano04@gmail.com",
"password": "senha123"
}{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZW1haWwiOiJmZWxpcGVmY2xhcmlhbm8wNEBnbWFpbC5jb20iLCJpYXQiOjE2NTYyOTM3MjMsImV4cCI6MTY1NjQ2NjUyM30.E37LjpU7mPTMMmYK-9eLyjaPQ2MbFSvLbBLWWR3rfnQ",
"_links": [
{
"href": "http://localhost:8080/games",
"method": "GET",
"ref": "get_games"
},
{
"href": "http://localhost:8080/game",
"method": "POST",
"ref": "create_game"
}
]
}{
"err": "Email inválido ou ausente."
}{
"err": "Senha ausente."
}{
"err": "Credenciais inválidas."
}{
"err": "O email enviado não exite na base de dados."
}{
"err": "Erro interno."
}Responsável por retornar todos os games do database
Nenhum
{
"games": [
{
"id": 1,
"title": "Minecraft",
"year": "2012",
"price": 30,
"createdAt": "2022-06-22T23:41:56.000Z",
"updatedAt": "2022-06-22T23:41:56.000Z"
},
{
"id": 2,
"title": "Sea of Thieves",
"year": "2018",
"price": 50.9,
"createdAt": "2022-06-22T23:41:56.000Z",
"updatedAt": "2022-06-23T21:54:52.000Z"
},
{
"id": 3,
"title": "Call of Dutty MW",
"year": "2019",
"price": 37.84,
"createdAt": "2022-06-22T23:41:56.000Z",
"updatedAt": "2022-06-27T16:42:25.000Z"
},
{
"id": 4,
"title": "Transformice",
"year": "2010",
"price": 0,
"createdAt": "2022-06-23T16:27:06.000Z",
"updatedAt": "2022-06-23T16:27:06.000Z"
},
{
"id": 7,
"title": "Sonic",
"year": "1991",
"price": 10.75,
"createdAt": "2022-06-23T16:33:58.000Z",
"updatedAt": "2022-06-23T17:24:29.000Z"
},
{
"id": 9,
"title": "Ben 10 - Protector of Earth",
"year": "2007",
"price": 12,
"createdAt": "2022-06-24T00:48:31.000Z",
"updatedAt": "2022-06-24T00:48:31.000Z"
},
{
"id": 10,
"title": "Rocket League",
"year": "2015",
"price": 0,
"createdAt": "2022-06-24T00:52:10.000Z",
"updatedAt": "2022-06-24T20:27:57.000Z"
}
],
"_links": [
{
"href": "http://localhost:8080/game",
"method": "POST",
"ref": "create_game"
}
]
}{
"err": "Não há games cadastrados."
}Responsável por retornar dados de um game específico.
:id - id do game que deseja ver os dados.
/game/4
/game/25
{
"game": {
"id": 3,
"title": "Call of Dutty MW",
"year": "2019",
"price": 37.84,
"createdAt": "2022-06-22T23:41:56.000Z",
"updatedAt": "2022-06-27T16:42:25.000Z"
},
"_links": [
{
"href": "http://localhost:8080/games",
"method": "GET",
"ref": "get_games"
},
{
"href": "http://localhost:8080/game/3",
"method": "DELETE",
"ref": "delete_game"
},
{
"href": "http://localhost:8080/game/3",
"method": "PUT",
"ref": "edit_game"
}
]
}{
"err": "ID inválido"
}{
"err": "Game não encontrado."
}Responsável por cadastrar um game no database.
title: Título do game
year: Ano de lançamento do game
price: Preço do jogo
{
"title": "League of Legends",
"year": 2009,
"price": 0
}{
"_links": [
{
"href": "http://localhost:8080/games",
"method": "GET",
"ref": "get_games"
},
{
"href": "http://localhost:8080/game",
"method": "POST",
"ref": "create_game"
}
]
}{
"err": "Título inválido ou ausente."
}{
"err": "Ano de lançamento inválido ou ausente."
}{
"err": "Preço inválido ou ausente."
}{
"err": "Erro interno."
}Responsável por deletar um game específico do database.
:id - id do game que deseja deletar.
/game/4
/game/25
{
"_links": [
{
"href": "http://localhost:8080/games",
"method": "GET",
"ref": "get_games"
},
{
"href": "http://localhost:8080/game",
"method": "POST",
"ref": "create_game"
}
]
}{
"err": "ID inválido."
}{
"err": "Erro interno."
}Responsável por editar games no database.
:id - id do game que deseja editar.
title: Título do game
year: Ano de lançamento do game
price: Preço do jogo
/game/4
/game/25
{
"_links": [
{
"href": "http://localhost:8080/games",
"method": "GET",
"ref": "get_games"
},
{
"href": "http://localhost:8080/game/12",
"method": "GET",
"ref": "get_game"
},
{
"href": "http://localhost:8080/game",
"method": "POST",
"ref": "create_game"
}
]
}{
"err": "ID inválido."
}{
"err": "Ano de lançamento inválido."
}{
"err": "Preço inválido."
}{
"err": "Game não encontrado."
}{
"err": "Erro interno."
}