Este README detalha o projeto da API para um sistema de usuários. O projeto foi desenvolvido em Node.js utilizando o Express e o Sequelize como ORM (Object-Relational Mapping). A API permite operações básicas de CRUD (Create, Read, Update, Delete) para gerenciar usuários em um banco de dados MySQL.
Para começar a usar esta API, é fundamental que você tenha um ambiente de desenvolvimento configurado. Certifique-se de ter as seguintes ferramentas instaladas em sua máquina:
- Node.js: É uma plataforma JavaScript usada para construir o servidor. Node.js é um ambiente de execução JavaScript no lado do servidor que permite aos desenvolvedores criar aplicativos web escaláveis. Download Node.js
- NPM (Node Package Manager): É um gerenciador de pacotes para Node.js. Ele permite que os usuários instalem e atualizem suas dependências de projeto. Download NPM
- Express: É um Framework web para Node.js. Ele simplifica o desenvolvimento de aplicativos web ao fornecer uma série de recursos pré-construídos. Download Express
- Sequelize: É um ORM (Object-Relational Mapping) para Node.js. Ele fornece uma maneira de interagir com bancos de dados SQL como MySQL, PostgreSQL, SQLite, etc., usando JavaScript. Download Sequelize
- MySQL: É um sistema de banco de dados relacional. MySQL é uma das opções mais populares para bancos de dados relacionais, que podem ser gerenciados usando SQL (Structured Query Language). Download MySQL
git clone https://github.com/AlessandroWindson/API-SISTEMA-DE-USUARIOS.git
cd SISTEMA-DE-USUARIOS-API
- Instale todas as dependências necessárias:
Node.js (inclui NPM, que geralmente vem junto com o Node.js)
Express: Express: Framework web para Node.js.
Para iniciar um novo projeto Express, primeiro você precisa ter o Node.js e o NPM instalados. Em seguida, siga estes passos:
mkdir meu-projeto-express
cd meu-projeto-express
npm init -y
npm install express
Sequelize: ORM (Object-Relational Mapping) para Node.js.
Para usar o Sequelize em conjunto com o Node.js, você precisa configurar o Sequelize e inicializar sua conexão com o banco de dados:
npm install --save-dev sequelize-cli
npm install sequelize mysql2
npx sequelize-cli init
npx sequelize-cli model:generate --name Usuario --attributes nome:string,email:string,senha:string
npx sequelize-cli db:migrate
MySQL2: Pacote para conexão com MySQL em Node.js.
Para usar o MySQL2 diretamente no terminal, você pode usá-lo para acessar e gerenciar seu banco de dados MySQL:
npm install -g mysql2
mysql -u root -p
Isso abrirá o prompt do MySQL. Insira sua senha quando solicitado.
Estes comandos devem ser executados no terminal dentro do diretório do seu projeto Node.js para instalar cada uma das dependências necessárias. Certifique-se de que o Node.js está instalado corretamente na sua máquina antes de prosseguir com essas instalações.
Acesso ao MySQL pelo terminal:
mysql -u root -p
Isso abrirá o prompt do MySQL. Insira sua senha quando solicitado.
CREATE DATABASE sistema_de_usuarios_development;
Substitua sistema_de_usuarios_development pelo nome desejado para o seu banco de dados.
SHOW DATABASES;
Isso listará todos os bancos de dados existentes, incluindo o novo que você acabou de criar.
Se você já configurou o Sequelize anteriormente como foi descrito, provavelmente já tem um arquivo de configuração (config/config.js) onde você especifica os detalhes de conexão com o banco de dados. Certifique-se de que as informações de conexão estão corretamente configuradas nesse arquivo.
Renomeie o arquivo .env.example para .env e edite-o com as configurações do seu banco de dados MySQL:
DB_HOST=127.0.0.1
DB_USER=root
DB_PASS=senha123@
DB_NAME=database_development
No arquivo de configuração do Sequelize (config/config.js), ajuste as configurações para usar as variáveis de ambiente definidas no arquivo .env. Um exemplo básico de configuração pode ser:
require('dotenv').config();
module.exports = {
development: {
username: process.env.DB_USER,
password: process.env.DB_PASS,
database: process.env.DB_NAME,
host: process.env.DB_HOST,
dialect: 'mysql'
},
// Configurações para outros ambientes (produção, teste) se necessário
};
No arquivo onde você inicializa o Sequelize (models/index.js), adicione o código para autenticar e sincronizar com o banco de dados. Geralmente, isso já é feito automaticamente se você seguiu o padrão gerado pelo Sequelize CLI. Por exemplo:
const { Sequelize } = require('sequelize');
const sequelize = new Sequelize(process.env.DB_NAME, process.env.DB_USER, process.env.DB_PASS, {
host: process.env.DB_HOST,
dialect: 'mysql'
});
sequelize.authenticate()
.then(() => {
console.log('Conexão com o banco de dados estabelecida com sucesso.');
return sequelize.sync(); // Isso sincroniza todos os modelos com o banco de dados
})
.catch(err => {
console.error('Erro ao conectar com o banco de dados:', err);
});
module.exports = sequelize;
Se você estiver usando Sequelize migrations para criar suas tabelas, execute o comando a seguir para aplicar as migrations ao banco de dados:
npx sequelize-cli db:migrate
Esse comando aplicará todas as migrations pendentes e criará as tabelas no banco de dados de acordo com os modelos definidos.
Com esses passos, você criará e configurará corretamente seu banco de dados MySQL para trabalhar com seu projeto Node.js utilizando Sequelize como ORM. Certifique-se de ajustar os detalhes conforme necessário para o seu ambiente específico de desenvolvimento.
Certifique-se de que seu banco de dados MySQL está em execução e que você criou um banco de dados com o nome especificado no arquivo .env.
Agora que a API está instalada e configurada corretamente, você está pronto para executar a aplicação. Siga as instruções abaixo:
- Inicie o servidor com o seguinte comando:
npm run dev
npm start
- O servidor estará rodando na porta 3000. Você pode acessar a API em
http://localhost:3000/api/usuarios.
A API fornece os seguintes endpoints:
- Criar um usuário
- URL:
/api/usuarios - Método:
POST - Corpo da Requisição:
- URL:
{
"nome": "Nome do Usuário",
"email": "[email protected]",
"senha": "senha_123"
}
- Listar todos os usuários
- URL:
/api/usuarios - Método:
GET
- URL:
- Obter um usuário por ID
- URL:
/api/usuarios/:id - Método:
GET
- URL:
- Atualizar um usuário
- URL:
/api/usuarios/:id - Método:
PUT - Corpo da Requisição:
- URL:
{
"nome": "Novo Nome do Usuário",
"email": "[email protected]",
"senha": "nova_senha_456"
}
- Deletar um usuário
- URL:
/api/usuarios/:id - Método:
DELETE
- URL:
Testar a API é uma parte crucial do desenvolvimento. Recomendamos o uso de ferramentas como Insomnia ou Postman para testar os endpoints da API.
Exemplo de Configuração no Insomnia
- Abra o Insomnia e crie uma nova requisição.
- Selecione o método HTTP (GET, POST, PUT, DELETE).
- Insira a URL do endpoint (por exemplo,
http://localhost:3000/api/usuarios). - Para requisições POST e PUT, vá para a aba "Body", selecione "JSON" e insira o corpo da requisição.
- Clique em "Send" para enviar a requisição e visualizar a resposta.
Este README fornece informações detalhadas para que os usuários do projeto entendam como utilizá-lo e configurá-lo adequadamente. Personalize conforme necessário e adicione quaisquer informações adicionais específicas para o seu projeto.