# CRUD da tabela animal
# GET Listar Animais
ENDPOINT:
ENTRADA: NENHUMA
SAÍDA: [lista com todos os animais cadastrados na fazenda]
Exemplo de saída:
[
{
"id": 1,
"localId": 1,
"tipoAnimal": "Galo",
"sexo": "macho",
"descricao": "Galinha que põe grandes ovos",
"createdAt": "2021-01-06T17:33:04.105Z",
"updatedAt": "2021-01-08T13:58:48.792Z"
},
{
"id": 2,
"localId": 1,
"tipoAnimal": "Galinha",
"sexo": "macho",
"descricao": "Galinha caída do caminhão",
"createdAt": "2021-01-06T18:15:05.830Z",
"updatedAt": "2021-01-07T03:39:22.401Z"
},
{
"id": 3,
"localId": 3,
"tipoAnimal": "Vaca",
"sexo": "Femea",
"descricao": "Vaca nascida na fazenda",
"createdAt": "2021-01-06T18:17:17.933Z",
"updatedAt": "2021-01-06T18:17:17.933Z"
}
]
DESCRIÇÃO: Retorna um JSON que irá conter os dados de todos os animais cadastrados.
# POST Cadastrar Animal
ENDPOINT:
ENTRADA:
Atributos | Descrição |
---|---|
localId | Id do local onde o animal está alocado |
tipoAnimal | Tipo do animal, seja galinha, vaca ou etc.... |
descricao | Breve descrição sobre o animal cadastrado |
SAÍDA: Mostra o animal cadastrado, confirmando que o cadastro foi feito com sucesso.
Exemplo de saída:
{
"localId" : 2,
"tipoAnimal" : "Galinha",
"sexo" : "femea",
"descricao" : "Galinha caída do caminhão"
}
DESCRIÇÃO: : Função que cadastra o animal na fazenda e o coloca no local informado.
# PUT Alterar Animal
ENDPOINT: PUT /animal/:id
ENTRADA:
Atributos | Descrição |
---|---|
id | Id do animal que sofrerá alterações |
localId | Id do local onde o animal está alocado |
tipoAnimal | Tipo do animal, seja galinha, vaca ou etc.... |
descricao | Breve descrição sobre o animal cadastrado |
Exemplo de entrada:
{
"localId" : 2,
"tipoAnimal" : "Galinha",
"sexo" : "macho",
"descricao" : "Galinha comprada a vista"
}
SAÍDA:
{
"message": "O animal foi alterado"
}
DESCRIÇÃO: Função que altera os dados do animal escolhido.
# DELETE Deletar Animal
ENDPOINT:
ENTRADA: NENHUMA
SAÍDA:
{
"message": "O animal foi removido"
}
DESCRIÇÃO: Função que exclui o animal que foi informado.