Api Rest Node.js e Express com autenticação de usuário utilizando JWT(Json Web Token), Nodemailer para recuperação de senha, MongoDB Atlas para serviços de armazenamento de dados na nuvem e um sistema CRUD para cadastro, leitura, atualização e exclusão de projetos e suas tarefas.
Antes de tudo, é preciso saber. Em Instalação, logo após clonar o repositório, é preciso configurar a estrutura do arquivo mail.json com as credenciais SMTP do seu provedor de email. O arquivo está localizado na pasta config. No projeto foi utilizado a ferramenta Mailtrap para testar o envio de email.
{
"host": "smtp.domain.io",
"port": 2525,
"secure": false,
"user": "username@domain.com",
"pass": "password"
}
Depois, é preciso criar um Cluster no MongoDB Atlas. Crie um conta, clique em Build my first cluster e deixe a configuração padrão. Clique em Create Cluster. Logo após, clique em CONNECT para criar um conexão com o banco de dados, clique em Add a Different IP Address e digite o seguinte ip 0.0.0.0/0 que permite o acesso ao seu banco de dados de qualquer lugar, depois clique em Add IP Address. Na mesma página crie um username e password do banco de dados, anote as credenciais. Clique em Create MongoDB User e, em seguida, clique em Choose a connection method, escolha a opção Connect your application, selecione o driver Node.js e copie a string de conexão na parte inferior de Connection String Only. Clique em Close.
Por fim, configure as variáveis de ambiente no arquivo .env na raíz do projeto. Cole a string de conexão no valor a ser recebido na variável mongodb_url. Substitua pela senha do usuário do banco de dados. Troque o nome do banco de dados test por um de sua preferência. Na variável jwt_key, crie uma chave secreta para criar o token de autenticação. Exemplo de chave secreta jw6s5hi53s97dhs07dhsk4vc0a6. A variável port manterá o número de porta que o aplicativo estará em execucão.
module.exports = {
mongodb_url: 'mongodb+srv://username:<password>@cluster0-3etgl.mongodb.net/test?retryWrites=true&w=majority',
jwt_key: '<chave_secreta>',
port: 4000
}
Instale o nodemon globalmente
npm install -g nodemon
Fazer o clone do repositório
git clone https://github.com/rodrigo93sj/node-rest-api
Instalar os pacotes
npm install
Rodar o servidor
yarn start
Utilize o Insomnia para testar a API, ou algum de sua preferência.
Para criar um usuário, crie e utilize a rota http://localhost:4000/register com método POST, especificando name, email e password. Por padrão, isAdmin vem como false. Caso queira alterá-la para true, adicione isAdmin: true no corpo da requisição.
{
"name": "test",
"email": "test@gmail.com",
"password": "test123456"
}
Para autenticar usuário, crie e utilize a rota http://localhost:4000/auth com método POST, especificando email e password.
{
"email": "test@gmail.com",
"password": "test123456"
}
Após autenticar usuário, é gerado um token. Copie o token e cole no Header das requisições que precisam da autenticação do usuário. Criar rota http://localhost:4000/user com método GET. Adicionar uma nova Header na requisição Authorization e um valor Bearer token_de_acesso_do_usuario.
Para trocar de senha, um email é enviado ao usuário com token para ser adicionado a requisição reset_password. Crie e utilize a rota http://localhost:4000/auth/forgot_password com método POST para enviar o token ao email do usuário. Copie o token.
{
"email": "test@gmail.com"
}
Crie e utilize a rota http://localhost:4000/auth/reset_password com método POST para trocar a senha do usuário. Cole o token no corpo da requisição.
{
"email": "rodrigoengj@gmail.com",
"token": "e08e7172c1c439f74721920cb8ea702924a6c283",
"password": "hudson19937416"
}
Para acessar rotas protegidas é preciso copiar o token de autenticação do usuário e colar na Header de cada requisição. Nova header Authorization e novo valor Bearer token_de_acesso_do_usuario.
Crie e utilize a rota http://localhost:4000/projects com método POST, para criar os projetos e suas tarefas.
{
"title": "Projeto 1",
"description": "Descrição do projeto",
"tasks": [
{
"title": "Tarefa 1"
},
{
"title": "Tarefa 2"
}
]
}
Crie e utilize a rota http://localhost:4000/projects com método GET, para listar os projetos.
Crie e utilize a rota http://localhost:4000/projects/projectId com método PUT. Será necessário copiar o id de um projeto e substituir em projectId.
{
"title": "Projeto Atualizado",
"description": "Descrição do projeto atualizado",
"tasks": [
{
"title": "Tarefa atualizada"
}
]
}
Crie e utilize a rota http://localhost:4000/projects/projectId com método DELETE. Será necessário copiar o id de um projeto e substituir em projectId.
Crie e utilize a rota http://localhost:4000/projects/projectId com método GET. Será necessário copiar o id de um projeto e substituir em projectId.