Este é o json server da aplicação Close Worker - Uma página de busca de prestadores de serviços autônomos próximos ao usuário, na cidade do Rio de Janeiro – RJ.
A API tem um total de 4 endpoints, podendo cadastrar seu usuário, realizar login e cadastrar serviços na plataforma.
Para importar o JSON no Insomnia é só clicar no botão "Run in Insomnia". Depois é só seguir os passos que ele irá importar todos os endpoints em seu insomnia.
No momento este json server funciona apenas localmente, assim sua url base é: https://closework.onrender.com
yarnnode server.jsPOST /register - FORMATO DA REQUISIÇÃO
{
"name": "teste3",
"email": "teste3@gmail.com",
"password": "123456ab",
"contact": "(xx) xxxxx-xxxx",
"avatar": ""
}Caso dê tudo certo, a resposta será assim:
POST /register - FORMATO DA RESPOSTA - STATUS 201
{
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InRlc3RlM0BnbWFpbC5jb20iLCJpYXQiOjE2NzI4NTA1ODQsImV4cCI6MTY3Mjg1NDE4NCwic3ViIjoiNCJ9.fu3HRIq9kgDj4JHr0N4931dXWTpkirImHUGo4LNrESM",
"user": {
"email": "teste3@gmail.com",
"name": "teste3",
"contact": "(xx) xxxxx-xxxx",
"avatar": "teste3.png",
"id": 4
}
}Email já cadastrado:
POST /register -
FORMATO DA RESPOSTA - STATUS 400
"Email already exists"Por limitação de conhecimento a respeito das configurações do json server, não será retornado erros, caso a requisição seja enviada faltando algum item obrigatório, assim recomendamos atenção ao criar o objeto json , que será enviado na requisição de registro.
POST /login - FORMATO DA REQUISIÇÃO
{
"email": "teste3@gmail.com",
"password": "123456ab"
}Caso dê tudo certo, a resposta será assim:
POST /login - FORMATO DA RESPOSTA - STATUS 200
{
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InRlc3RlM0BnbWFpbC5jb20iLCJpYXQiOjE2NzI4NTM5NjEsImV4cCI6MTY3Mjg1NzU2MSwic3ViIjoiNCJ9.1tbCR_Vde9kMUVieatLxVKCqcwM4rEsOJlc3QkZ9AsM",
"user": {
"email": "teste3@gmail.com",
"name": "teste3",
"contact": "(xx) xxxxx-xxxx",
"avatar": "teste3.png",
"id": 4
}
}Com essa resposta, vemos que temos duas informações, o user e o token respectivo, dessa forma você pode guardar o token no localStorage para fazer a gestão do usuário no seu frontend.
Email incorreto:
POST /login -
FORMATO DA RESPOSTA - STATUS 400
"Cannot find user"Senha incorreta:
POST /login -
FORMATO DA RESPOSTA - STATUS 400
"Incorrect password"Não é preciso enviar body, ou token na requisição
GET /services - FORMATO DA REQUISIÇÃO
Caso dê tudo certo, a resposta será assim:
GET /services - FORMATO DA RESPOSTA - STATUS 200
[
{
"userId": 3,
"service_provider": "teste2",
"service_provider_avatar": "teste2.png",
"kind_of_service": "Pedreiro",
"phone_number": "(xx) xxxxx-xxxx",
"link_instagram": "https://www.instagram.com/teste2",
"id": 1
},
{
"userId": 2,
"service_provider": "teste1",
"service_provider_avatar": "teste1.png",
"kind_of_service": "Doceira",
"phone_number": "(xx) xxxxx-xxxx",
"link_instagram": "https://www.instagram.com/teste1",
"id": 4
}
]Não é preciso enviar body, ou token na requisição
GET /services?kind_of_service=${tipo_do_serviço} - FORMATO DA REQUISIÇÃO
Caso dê tudo certo, a resposta será assim:
GET /services?kind_of_service=${tipo_do_serviço} - FORMATO DA RESPOSTA - STATUS 200
[
{
"userId": 3,
"service_provider": "teste2",
"service_provider_avatar": "teste2.png",
"kind_of_service": "Pedreiro",
"phone_number": "(xx) xxxxx-xxxx",
"link_instagram": "https://www.instagram.com/teste2",
"id": 1
},
{
"userId": 2,
"service_provider": "teste1",
"service_provider_avatar": "teste1.png",
"kind_of_service": "Doceira",
"phone_number": "(xx) xxxxx-xxxx",
"link_instagram": "https://www.instagram.com/teste1",
"id": 4
}
]Rotas que necessitam de autorização deve ser informado no cabeçalho da requisição o campo "Authorization", dessa forma:
Authorization: Bearer {token}
GET /tokenAuth - FORMATO DA REQUISIÇÃO
Só é preciso enviar o token na requisição, o body fica vazio.
Caso dê tudo certo, a resposta será assim:
GET /tokenAuth - FORMATO DA RESPOSTA - STATUS 200
{
"ok": "Token válido"
}Token não foi enviado:
GET /tokenAuth - FORMATO DA RESPOSTA - STATUS 401
"Missing token"Token não é válido:
GET /tokenAuth - FORMATO DA RESPOSTA - STATUS 401
"invalid signature"GET /users/${idUsuário} - FORMATO DA REQUISIÇÃO
Só é preciso enviar o token na requisição, o body fica vazio.
Caso dê tudo certo, a resposta será assim:
GET /users/${idUsuário} - FORMATO DA RESPOSTA - STATUS 200
{
"email": "usercoments@gmail.com",
"password": "$2a$10$YQiiz0ANVwIgpOjYXPxc0O9H2XeX3m8OoY1xk7OGgxTnOJnsZU7FO",
"name": "userComents",
"contact": "(xx) xxxxx-xxxx",
"avatar": "userComents.png",
"id": 1
}Token não foi enviado:
GET /users/${idUsuário} - FORMATO DA RESPOSTA - STATUS 401
"Missing token"Token inválido:
GET /users/${idUsuário} - FORMATO DA RESPOSTA - STATUS 401
"invalid signature"O id utilizado não pertence ao dono do token:
GET /users/${idUsuário} - FORMATO DA RESPOSTA - STATUS 401
"Private resource access: entity must have a reference to the owner id"O id utilizado não existe no banco de dados:
GET /users/${idUsuário} - FORMATO DA RESPOSTA - STATUS 401
"Cannot read properties of undefined (reading 'id')"PATCH /users/${idUsuário} - FORMATO DA REQUISIÇÃO
{
"name": "teste111",
"contact": "(xx) xxxxx-xxxx",
"avatar": "teste111.png"
}Caso dê tudo certo, a resposta será assim:
`GET /users/${idUsuário} - FORMATO DA RESPOSTA - STATUS 200`
{
"email": "teste1@gmail.com",
"password": "$2a$10$Ir9eXMtbpV4a1GSouLIHkuMX7W9SbNlNpli7z15uURivQOD927w16",
"name": "teste111",
"contact": "(xx) xxxxx-xxxx",
"avatar": "teste111.png",
"id": 2
}GET /users/${idUsuário}?_embed=services - FORMATO DA REQUISIÇÃO
Só é preciso enviar o token na requisição, o body fica vazio.
Caso dê tudo certo, a resposta será assim:
GET /users/${idUsuário}?_embed=services - FORMATO DA RESPOSTA - STATUS 200
{
"email": "teste1@gmail.com",
"password": "$2a$10$h0I5EhMJEH1xubklvQ.L8u1skjLUjOqc0ztjzRZakOmX0yriSThTi",
"name": "teste1",
"contact": "(xx) xxxxx-xxxx",
"avatar": "teste1.png",
"id": 2,
"services": [
{
"userId": 2,
"service_provider": "teste1",
"service_provider_avatar": "teste1.png",
"kink_of_service": "Doceira",
"phone_number": "(xx) xxxxx-xxxx",
"link_instagram": "https://www.instagram.com/teste1",
"id": 4
},
{
"userId": 2,
"service_provider": "teste1",
"service_provider_avatar": "teste1.png",
"kink_of_service": "Diarista",
"phone_number": "(xx) xxxxx-xxxx",
"link_instagram": "https://www.instagram.com/teste1",
"id": 5
},
{
"userId": 2,
"service_provider": "teste1",
"service_provider_avatar": "teste1.png",
"kink_of_service": "Costureira",
"phone_number": "(xx) xxxxx-xxxx",
"link_instagram": "https://www.instagram.com/teste1",
"id": 6
}
]
}Token não foi enviado:
GET /users/${idUsuário}?_embed=services - FORMATO DA RESPOSTA - STATUS 401
"Missing token"Token inválido:
GET /users/${idUsuário}?_embed=services - FORMATO DA RESPOSTA - STATUS 401
"invalid signature"O id utilizado não pertence ao dono do token:
GET /users/${idUsuário}?_embed=services - FORMATO DA RESPOSTA - STATUS 401
"Private resource access: entity must have a reference to the owner id"O id utilizado não existe no banco de dados:
GET /users/${idUsuário}?_embed=services - FORMATO DA RESPOSTA - STATUS 401
"Cannot read properties of undefined (reading 'id')"POST /services - FORMATO DA REQUISIÇÃO
{
"userId": 2,
"service_provider": "teste1",
"service_provider_avatar": "teste1.png",
"kink_of_service": "Servente",
"phone_number": "(xx) xxxxx-xxxx",
"link_instagram": "https://www.instagram.com/teste1"
}Caso dê tudo certo, a resposta será assim:
POST /services - FORMATO DA RESPOSTA - STATUS 200
{
"userId": 2,
"service_provider": "teste1",
"service_provider_avatar": "teste1.png",
"kink_of_service": "Servente",
"phone_number": "(xx) xxxxx-xxxx",
"link_instagram": "https://www.instagram.com/teste1",
"id": 8
}Por limitação de conhecimento a respeito das configurações do json server, não será retornado erros, caso a requisição seja enviada faltando algum item obrigatório, assim recomendamos atenção ao criar o objeto json , que será enviado na requisição de registro.
O "userId" se refere ao id do usuário logado dono do token enviado.