Projeto elaborado para conclusão do Bootcamp de Back-End promovido pela {reprograma} ocorrido entre Agosto e Dezembro de 2020 com duração de 18 semanas.
Sabemos da importância de manter em dia a vacinação para prevenir doenças como hepatites e sarampo, porém, muitas pessoas não fazem ideia de onde guardaram o seu cartão de vacina ou muitas vezes ele está muito antigo e de difícil leitura. Foi a partir desse problema que surgiu a ideia de uma API de um cartão de vacina virtual que tem a proposta das pessoas poderem ter o controle de suas vacinas.
O objetivo do projeto é possibilitar o registro de usuários e vacinas, possibilitando visualizar todos ou por ID, fazer atualizações de campo específico, assim como ser possível deletar registros. Todo o desenvolvimento da API foi pensado na utilização de boas práticas e estrutura de pastas, seguindo o design MVC. Além disso, a utilização dos métodos relacionados ao banco de dados MongoDB e suas consultas avançadas.
https://vacina-em-dia.herokuapp.com/
🚧 Em construção... 🚧
GET: /
Apresenta o título da API e sua versão.
Resposta [200]:
{
"titulo": "Vacina em Dia",
"versao": "1.0.0"
}POST: admin/register
Criar novo usuário administrador. Ele que terá acesso a determinadas rotas.
Body necessário:
{
"name": "string",
"email": "string",
"password": "string"
}Resposta [200]:
{
"_id": "object ID",
"name": "string",
"email": "string",
"password": "string"
}Resposta [400] quando o usuário administrador insere o e-mail igual a um já cadastrado:
{
"error": [
"Já existe uma conta com esse e-mail."
]
}Resposta [400] quando o usuário administrador cria uma senha com menos de 8 caracteres:
{
"errors": [
"A senha precisa ter no mínimo 8 caracteres."
]
}Fazer login na API para gerar o JSON Web Token que será enviado em todas as requisições protegidas que apenas o usuário administrador terá acesso.
POST: /login/admin
Body necessário:
{
"email": "string",
"password": "string"
}Resposta [200]:
{
"admin": {
"id": "object ID",
"email": "string"
},
"token": "string"
}Resposta [401]:
{
"error": "Administrador não encontrado."
}Resposta [401]:
{
"error": "Senha não corresponde."
}GET: /users
Lista todos os usuários. É necessário autorização com token no padrão: Bearer Token.
Resposta [200]:
[
{
"_id": "object ID",
"vaccinesTaken": "array",
"name": "string",
"email": "string",
"password": "string",
"cpf": "string",
"phone": "string",
}
]Resposta [401]:
{
"error": "Token não fornecido."
}POST: /register
Criar novo usuário.
Body necessário:
{
"name": "string",
"email": "string",
"password": "string",
"cpf": "string",
"phone": "string"
}Resposta [200]:
{
"_id": "object ID",
"vaccinesTaken": "array",
"name": "string",
"email": "string",
"password": "string",
"cpf": "string",
"phone": "string",
}Resposta [400] quando o usuário insere o e-mail igual a um já cadastrado:
{
"error": [
"Já existe uma conta com esse e-mail."
]
}Resposta [400] quando o usuário cria uma senha com menos de 8 caracteres:
{
"errors": [
"A senha precisa ter no mínimo 8 caracteres."
]
}GET: /users/{id}
Visualizar usuário por ID.
Resposta [200]:
Usuário com o ID informado.
{
"_id": "object ID",
"vaccinesTaken": "array",
"name": "string",
"email": "string",
"password": "string",
"cpf": "string",
"phone": "string",
}Resposta [400]:
Quando o ID informado está incorreto.
{
"message": "O ID especificado não é válido."
}GET: /card/{id}
Visualizar o cartão do usuário a partir do seu ID.
Resposta [200]:
Usuário com o ID informado.
{
"vaccinesTaken": [
{
"_id": "object ID",
"name": "string",
"dose": "string",
"avoidedDiseases": "string"
},
{
"_id": "object ID",
"name": "string",
"dose": "string",
"avoidedDiseases": "string"
}
],
"_id": "object ID",
"name": "string",
"email": "string",
"cpf": "string",
"phone": "string"
}Resposta [400]:
Quando o ID informado está incorreto.
{
"message": "O ID especificado não é válido."
}PATCH: /phone/{id}
Edita o telefone do usuário com o ID indicado.
Body necessário:
{
"phone":"string"
}Resposta [200]:
{
"message": "O telefone do usuário de id: {id} foi atualizado com sucesso."
}Resposta [400]:
Quando o ID informado está incorreto.
{
"message": "O ID especificado não é válido."
}DELETE: /:id
Deletar um usuário a partir do seu ID. É necessário autorização com token no padrão: Bearer Token.
Resposta [200]:
{
"message": "Usuário deletado com sucesso."
}Resposta [401]:
{
"error": "Token não fornecido."
}GET: /vaccines
Listar todas as vacinas em ordem alfabética.
Resposta [200]:
[
{
"_id": "object ID",
"name": "string",
"date": "date",
"dose": "string"
}
]GET: /name
Lista a vacina pelo nome.
Params necessário:
| Key | Value |
|---|---|
| name | Nome da vacina |
Resposta [200]:
[
{
"_id": "object ID",
"name": "string",
"date": "date",
"dose": "string",
"avoidedDiseases": "string"
}
]POST: /register
Cadastrar vacina. É necessário autorização com token no padrão: Bearer Token.
Body necessário:
{
"name": "string",
"dose": "string",
"avoidedDiseases": "string"
}Resposta [201]:
{
"_id": "object ID",
"name": "string",
"date": "date",
"dose": "string",
"avoidedDiseases": "string"
}Resposta [400]:
{
"error": [
"Já existe essa vacina cadastrada."
]
}Resposta [401]:
{
"error": "Token não fornecido."
}GET: /vaccines/{id}
Visualizar vacina pelo seu ID.
Resposta [200]:
Vacina com o ID informado.
{
"_id": "object ID",
"name": "string",
"date": "date",
"dose": "string",
"avoidedDiseases": "string"
}Resposta [400]:
Quando o ID informado está incorreto.
{
"message": "O ID especificado não é válido."
}PATCH: /vaccinestaken/{id}
Atualizar as vacinas tomadas do usuário. É necessário autorização com token no padrão: Bearer Token.
Body necessário:
{
"name": "string",
"dose": "string"
}Resposta [200]:
{
"vaccinesTaken": [
"object ID",
"object ID"
],
"_id": "object ID",
"name": "string",
"email": "string",
"password": "string",
"cpf": "string",
"phone": "string"
}Resposta [400]:
Quando o ID informado está incorreto.
{
"message": "O ID especificado não é válido."
}Resposta [401]:
{
"error": "Token não fornecido."
}Resposta [404]:
{
"error": [
"Não existe essa vacina cadastrada na base de dados."
]
}DELETE: /{id}
Deletar uma vacina a partir do seu ID. É necessário autorização com token no padrão: Bearer Token.
Resposta [200]:
{
"message": "Vacina deletada com sucesso."
}Resposta [401]:
{
"error": "Token não fornecido."
}- Não pode existir usuários iguais.
- O CPF não pode ser alterado.
- Apenas o usuário administrador poderá cadastrar e deletar vacinas.
- Apenas o usuário administrador poderá inserir as vacinas tomadas.
- Apenas o usuário administrador poderá visualizar todos os usuários e deletá-los.
- Não pode inserir no cartão do usuário uma vacina que não está cadastrada na base de dados.
- Listar todas as vacinas por ordem alfabética.
-
Clone esse repositório
-
Faça npm install em seu terminal para instalar as dependências.
npm install
-
Para rodar o servidor em ambiente de desenvolvimento, digite npm run dev no terminal:
npm run dev
-
Ou se preferir, apenas npm start:
npm start
Foram utilizadas no desenvolvimento do projeto as seguintes tecnologias:
- Git e Github;
- Visual Studio Code;
- Node.js;
- Express.js;
- Nodemon;
- MongoDB;
- Mongoose;
- Cors;
- Bcrypt;
- Yup;
- Jsonwebtoken.
Obs.: O Nodemon está como dependência de desenvolvimento.
- Detalhamento das vacinas por faixa etária da pessoa.
- Opção de filtrar por vacinas específicas de acordo com a idade da pessoa.
- Visualizar as vacinas que o usuário ainda precisa tomar.
- Inserir a busca pelo CPF do usuário.
- Implementar autenticação para o usuário comum.
Este projeto encontra-se em desenvolvimento e está aberto para pull request.
Feito com ❤️ por Irla Andrade 👋🏽 Entre em contato:
