Loja de Informática API

Projeto educacional do curso de Web Dev Full Stack da Resilia Educação referente ao Módulo 04, utilizando o Node.js com framework Express.
Explore os arquivos do projeto. »

1. Sobre o projeto
2. Como instalar e iniciar o projeto

O objeto proposto como projeto final do módulo 4, é criar uma API Rest de uma Loja de Informática. Criei a entidade 'Funcionarios' e com ela você poderá realizar as operações básicas CRUD, que são elas:

• Ler todos os funcionarios, e suas informaçoes do banco de dados, ou, filtrar um funcionario por ID ou por nome.
• Adicionar novos funcionarios no banco de dados.
• Deletar um funcionario pelo número do ID.
• Atualizar um ou vários dados de um funcionario.

• JavaScript
• Node.js v16.14.0
• NPM v8.3.1
• Express v4.17.3
• Nodemon v2.0.15
• SQLite v5.0.2

Este é um exemplo sobre como instalar e configurar seu projeto localmente. Para fazer uma cópia local e iniciar, siga estas etapas de exemplo simples.

Lembre-se do que você irá precisará ter instalado em sua máquina para executar o prejeto. 👇

1. Instale NPM

   npm install

2. Instale Express

   npm install express

3. Instale Nodemon

   npm install nodemon

4. Instale SQLite

   npm install sqlite3

5. Instale Jest

   npm install jest

6. Instale Super Test

   npm install supertest

Abra o terminal/Powershell e rode os comandos abaixo:

Para clonar o repositório:

  git clone https://github.com/FilpeRibeiro/Projeto-M4-API.git

Acesse a pasta criada:

cd Projeto-M4-API

Para iniciar os projetos use o comando abaixo

npm start

Para executar o teste da rota post e da corpo das rotas executar

npm run test

Para o arquivo 'database.db' ser populado, executete o arquivo cria-inseri.js Para fazê-lo rodar, abra seu terminal e execute o comando:

npm run create

*OBS: Caso de algum erro ao rodar os comandos colocar na pasta packjson a linha :
"type":"modules",

Ao executar a entidade funcionarios, aparecerá os atributos adicionados à ela, que são: id, nome, email, cpf, cargo. Veja os resultados:

• Método GET para visualizar todos os funcionarios marcados. ( /funcionario)

Schema da resposta.

{
	"Funcionarios": [
		{
			"ID": 1,
			"NOME": "Filipe Ribeiro Martins",
			"EMAIL": "[email protected]",
			"CPF": "123456789",
			"CARGO": "Suporte"
		},
  ]

• Método GET para filtrar um dado por EMAIL ( /funcionario/email/{o email do funcionario})

Schema da resposta.

{
	"funcionario": [
		{
			"ID": 5,
			"NOME": "Rafaela Souza",
			"EMAIL": "[email protected]",
			"CPF": "***********",
			"CARGO": "suporte"
		}
	],
	"erro": false
}

• Método POST para adicionar um novo funcionario ( /funcionario)

Schema da resposta.

{
  "Mensagem": (string),
  "Erro": (booleano)
 }

• Método DELETE para apagar um funcionario por ID ( /funcionario/id/{o número de id})

Schema da resposta.

{
  "Mensagem": (string),
  "Erro": (booleano)
  }

• Método PUT para atualizar um funcionario por ID ( /funcionario/id/{o número de id})

Schema da resposta.

{
	"mensagem": "Funcionario de id 1 atualizado com sucesso",
	"funcionario": {
		"nome": "Filipe Ribeiro Martins",
		"email": "[email protected]",
		"cpf": "123456789",
		"cargo": "Suporte"
	},
	"erro": false
}