Esse projeto é dedicado aos meus estudos a respeito de Spring e springBoot, sendo um pequeno CRUD da classe User
CLASSE: User mapeamento de atributos
campo | tipo | obrigatório | descrição |
---|---|---|---|
id | inteiro | SIM | Chave primária dessa entidade |
String | SIM | campo mandatório | |
password | String | SIM | Campo mandatório |
GET
/users
Retorna uma lista com todos os usuários, veja abaixo um exemplo do retorno
{
"users": [
{
"id": "1",
"email": "jeff@email.com",
"password": "senha123"
},
{
"id": "2",
"email": "alex@example.com",
"password": "secretword"
}
]
}
Respostas
código | descrição |
---|---|
200 | os dados foram retornados |
404 | endereço não encontrado |
POST
/users
Registra um usuário na nosso banco de dados,nessa requisição é necessário colocar um body no formato JSON, segue abaixo um exemplo do body:
{
"email": "alexandre@gmail.com",
"password": "senhaMuitoBoa"
}
Respostas
código | descrição |
---|---|
201 | a clinica foi cadastrada com sucesso |
400 | campos inválidos |
GET
/users/{id}
Retorna o usuário com o ID informado na URL da requisição, segue abaixo um exemplo de retorno:
{
"id": "1"
"email": "alexandre@gmail.com",
"password": "senhaMuitoBoa"
}
Respostas
código | descrição |
---|---|
200 | os dados foram retornados |
404 | não foi encontrado User com esse ID |
PUT
/users/{ID}
Atualiza um User em nosso DB, essa requisição recebe um body em formato JSON, segue abaixo o exemplo:
{
"id": "1"
"email": "alexandre@gmail.com",
"password": "senhaMuitoBoa"
}
Respostas
código | descrição |
---|---|
200 | os dados foram retornados |
404 | não foi encontrado User com esse ID |
DELETE
/users/{ID}
Deleta um User em nosso DB, essa requisição recebe um ID em sua URL
Respostas
código | descrição |
---|---|
204 | no-content |
404 | não foi encontrado User com esse ID |