Este projeto foi realizado, utilizando-se quatro bibliotecas, listadas abaixo, e aceita requisições GET, POST, PUT, e DELETE
- Express - Framework Node
- Mongoose - Integração com MongoDB
- Nodemon - Reinicia automaticamente o servidor quando detecta alterações
- CryptoJS - Criptografia das senhas salvas
- Pré Requisitos
- Instalação
- Utilização
- Rotas | Endpoints
- Tour pelos arquivos
- Uso de cada biblioteca
- Sobre o autor
Este projeto foi feito em um ambiente linux, sendo recomendado o uso do mesmo para utilização do projeto. O guia apresentado abaixo se dará para esse sistema.
Também é necessário que o usuário tenha o banco de dados mongodb instalado e ativo em seu computador.
Para ativar o servidor, basta digitar em seu terminal:
Para verificar se o sistema está ativo, digite:
A resposta deverá ser algo do tipo:
Para começar a utilizar esse projeto, é bem simples: basta instalar as dependências do projeto, digitando o seguinte comando em seu terminal:
Após instalar as dependências, também é necessário ligar o servidor. Para ativar o servidor, digite em seu terminal:
Com isso, ele mostrará que o servidor está iniciado e em qual porta.
Pra uma melhor experiencia, recomendo a utilização do Insomnia ou Postman, onde será possível ver e fazer as requisições de forma muito mais didática.
Após instalar as dependências, é só colocar na barra de URL a URL para requisição com a porta em que o servidor se encontra (neste caso, 3000), como no exemplo abaixo:
Essa é a URL base. Todas as rotas devem ser colocadas imediatamente após.
Exemplo: localhost:3000/create
Obs.: No navegador, também é possível fazer as requisições de post/put, porém são necessários alguns plugins/extensões de terceiros para efetuar tais ações.
A utilização se dá de forma simples, através de quatro principais rotas, que representam as operações básicas de um banco de dados (C.R.U.D - Create Read Update Delete) e mais algumas rotas auxiliares.
- No arquivo src/database/index.js, você encontrará variáveis moduladas para que o banco de dados seja selecionado. Por padrão, um banco local está configurado. Se este é o seu caso, não precisa fazer alterações :)
- Prezando pela segurança do usuário, senhas não aparecem em nenhum momento nas requisições ao banco de dados. Elas não são salvas diretamente, sendo primeiro encriptadas pela biblioteca MD5. Caso deseje visualizar as senhas nas requisições, basta comentar/deletar as linhas 16 e 107 do arquivo src/controllers/userControllers.js. Para retirar a encriptação, basta comentar/deletar da linha 34 à linha 39 do arquivo src/models/index.js.
- Na seção Uso de cada biblioteca, será explicado melhor sobre cada biblioteca utilizada.
- O identificador do usuário se dá tanto pelo _id (gerado automaticamente), como também pelo nome de usuário, que deverão ser únicos.
-
Através desse endpoint, é possível inserir/cadastrar usuários no banco de dados.
É necessário enviar uma requisição com o formato JSON no corpo, com o seguinte formato:
{ "name": "Nome do Usuário", "username": "Nome único DE usuário", "password": "Senha para login" }A resposta se dará em formato de objeto com duas chaves. A primeira mostrando um checkout com os dados que foram inseridos, e a segunda informando o status da operação.
Exemplo:
{ "newUser": { "name": "Elizabeth Queen", "username": "queen-lizzy", "_id": "6160754fb73a585a359710ff", "last_update": "2021-10-08T16:43:59.168Z" }, "status": 201 }Algumas observações:
-
Para a criação da senha, não há nenhum critério de validação quanto a tamanho ou força.
-
Todos estes campos devem estar preenchidos, e o username deverá ser único. Não seguir esses dois critérios retornará uma resposta 400 - Bad Request.
-
-
Através desse endpoint, é possível obter o cadastro de todos os usuários.
A resposta se dará com o seguinte formato:
{ "allUsers": [ { "_id": "6160754fb73a585a359710ff", "name": "Elizabeth Queen", "username": "queen-lizzy", "last_update": "2021-10-08T16:43:59.168Z" }, { "_id": "616075edb73a585a35971106", "name": "John Doe", "username": "john", "last_update": "2021-10-08T16:46:37.783Z" } ... ], "status": 200 } -
Através desse endpoint, é possível obter o cadastro de um usuário específico, passando o _id do usuário na rota.
Exemplo de rota:
A resposta se dará com o seguinte formato:
{ "findUser": { "_id": "616075edb73a585a35971106", "name": "John Doe", "username": "john", "last_update": "2021-10-08T16:46:37.783Z" }, "status": 200 }
-
Através desse endpoint, é possível atualizar o cadastro de um usuário específico, passando o _id do usuário na rota.
É necessário enviar uma requisição com o formato JSON no corpo, com o seguinte formato:
{ "name": "Marcelo D2", "username": "marcelod2" }A resposta se dará, mostrando os dados atualizados do usuário e o status da requisição, com o seguinte formato:
{ "findUser": { "_id": "616075edb73a585a35971106", "name": "Marcelo D2", "username": "marcelod2", "last_update": "2021-10-08T17:36:44.640Z" }, "status": 200 } -
Através desse endpoint, é possível simular o login de um usuário.
É necessário enviar uma requisição com o formato JSON no corpo, com o seguinte formato:
{ "username": "queen-lizzy", "password": "1234" }A resposta se dará, mostrando uma mensagem de sucesso ou de erro e o status da requisição, com o seguinte formato:
{ "message": "You successfully logged in!", "status": 200 }Algumas observações:
- Quando o usuário é criado, o campo last_login não existe. Ao utilizar este endpoint, o campo é criado (ou atualizado), recebendo como valor o horário em que a rota foi acessada.
-
Através desse endpoint, é possível deletar o cadastro de um usuário, passando-se o _id do usuário junto da rota.
Exemplo de rota:
A resposta se dará, mostrando uma mensagem de sucesso ou de erro e o status da requisição, com o seguinte formato:
{ "message": "User successfully deleted!", "status": 200 }
200 (OK) - Significa que está tudo OK, e a requisição foi bem sucedida.
204 (No Content) - Normalmente, esse é o status utilizado para métodos PUT e DELETE. Esses métodos não retornam nada, mesmo sendo uma requisição bem sucedida. Nesse projeto, estamos usando 200 para poder passar informação no retorno.
400 (Bad Request) - Significa que algo na requisição está errado. Pode ser a extensão do envio da requisição, algum erro na rota ou algum dado errado.
Todos os arquivos utilizados ficam dentro da pasta src/. Dentro dela, existem cinco arquivos/diretórios e suas subpastas. Vamos dar uma passada por cada um para ver como personalizar a aplicação, de acordo com seu gosto.
-
src/routes.js
Nesse arquivo, estão localizadas todas as possíveis rotas da aplicação, divididas em duas partes. A primeira são as rotas basicas de um CRUD, e a segunda parte são as rotas de login e de listagem de todos os usuários.
-
src/index.js
Esse é o arquivo principal da aplicação. Aqui ficam os middlewares do express, e aqui é chamado o uso das rotas. Há um middleware que, a cada vez que é disparado alguma requisição, imprime algumas informações no console. Também é impresso no console um aviso, dizendo que o servidor está aberto, e qual porta está sendo utilizada. O padrão é a porta 3000.
-
src/controllers/userController.js
É aqui onde fica o controles de como são lidas, e o que são feitas com as informações das requisições. É o cérebro da operação.
A função createUser é responsável por criar novos usuários. Há primeiro uma verificação pra ver se o usuário já está cadastrado no banco de dados, através de um username único. Se já tiver um username igual, um erro será retornado.
A função readUser é responsável por procurar um usuário pelo _id.
A função updateUser é responsável por atualizar o cadastro de um usuário. Essa função fará uma busca pelo _id do usuário passado no endpoint, e atualizará o username e/ou nome.
A função deleteUser é responsável por deletar o cadastro de um usuário. Será feito uma busca pelo _id passado no endpoint, e será verificado se o usuário realmente está no banco de dados ou não. Se estiver, será deletado.
A função showUsers mostra todos os usuários cadadstrados.
A função loginUser é responsável por simular um login de usuário. Ela fará uma busca pelo username no banco de dados, e fará uma comparação entre a criptografia da senha requisitada e a senha salva. Se forem iguais, ela retornará que o usuário está logado, e irá atualizar o cadastro do usuário com um campo last_login com a data em que foi feita a requisição.
Nesse arquivo, por ser responsável pelo controle entre as informações do banco de dados e as requisições, é possivel configurar se a senha será mostrada ou não em todas as requisições, e também quais informações serão mostradas, e como elas se interligarão umas com as outras.
-
src/database/index.js
Esse é o arquivo onde está configurado o acesso ao banco de dados.
Na constante databasePrefix, ficará a informação de prefixo do banco de dados. Por padrão, todas as informações desse arquivo estão configuradas para servir um banco de dados local. Caso se deseje usar um banco de dados externo, é necessário alterar a constante '+srv://' para o valor exigido por este banco de dados.
A constante databaseString armazena justamente a 'string' de acesso do banco de dados.
A constante databaseName armazenará o nome do banco de dados, e caso não exista nenhum banco de dados com esse nome, um será criado. Por padrão, o nome é users.
A função connect do mongoose juntará todas essas informações e dará acesso ao banco de dados.
-
src/models/user.js
É aqui que fica o modelo do banco de dados. Este arquivo define como serão as informações enviadas como documentos ao mongoDB.
No UserSchema, estão declaradas todas as informações que serão armazenadas. No segundo parâmetro dessa função, estão algumas informações gerais, como por exemplo versionKey: false. Essa chave declarada como false retira um campo, que é colocado por padrão, chamado "__v".
Logo abaixo, há uma função que faz com que, ao se fazer uma requisição com o campo "password", o valor dessa chave de senha seja criptografado com criptografia MD5. Essa biblioteca utilizada permite diferentes tipos de criptografia que podem ser utilizadas. Caso não se deseje criptografar uma senha a ser salva no banco de dados, basta deletar essa função.
Aqui, vou falar um pouco sobre o uso de cada biblioteca utilizada. Mesmo sendo poucas as bibliotecas, acho interessante explicar o propósito específico de cada uma, principalmente as menos conhecidas.
-
Express
O express é uma das principais ferramentas para se lidar com aplicações web Node.js. Um dos grandes benefícios do express são os middlewares, que interceptam requisições, e podem lidar com dados.
-
Mongoose
É o mongoose que faz a 'integração' entre o banco de dados mongo com o código em javascript. Seus métodos e funções próprias, além de aumentarem a produtividade, também permitem uma grande manipulação e manutenção dos dados.
-
Nodemon
O nodemon é uma ferramenta para desenvolvimento de projetos como esse. Ele é responsável por deixar o servidor aberto e, caso tenha alguma alteração nos arquivos, ele irá atualizar e reiniciar o servidor automaticamente, aumentando a produtividade.
-
CryptoJS
É uma biblioteca com padrões de criptografia diferentes. É muito bacana trabalhar com ela. Nesse projeto, ela serviu pra criptografar a senha do usuário salvo no banco de dados.
Olá! Que bom que chegou até aqui!
Eu me chamo Caio, e sou estudante de desenvolvimento Web. Comecei meus estudos no ano de 2021, e estou me apaixonando cada dia que passa, através dos estudos, por educação e tecnologia. Esse projeto e esse README foram desenvolvidos como um desafio técnico. Eu empenhei muito carinho na construção de cada linha.