Introdução

O projeto consiste em uma API criada em Node.js e um FrontEnd Básico com um Formulário para realizar os testes das operações GET, POST, PUT e DELETE.

O projeto possui a abstração de cadastro de clientes, onde é possível cadastra-los com os atributos NOME, EMAIL e IDADE, e realizar a Consulta, Atualização e Remoção apartir do ID do cliente.

Procedimento para Executar

1. Versão do Node.js

Verifique a versão do Node.js

node --version

Realize a instalação da versão e o uso da versão do Node.js, se necessário com nvm (ou baixe a versão):

nvm install 23.0
nvm use 23.0

2. Dependências

Instale as dependências com o gerenciador de dependêcias padrão do Node npm:

npm install

Esse comando irá funcionar apenas se houver os arquivos package.json e o package-lock.json na raiz do projeto

3. Executando a API

Realize a execução da API utilzando o comando do node:

node handlers\server.js

Ao receber a mensagem de Servidor rodando na porta 3000 ! você já tem disponível sua API localmente, e você pode acessar no navegador ou no postman pela URI: http:\\localhost:3000

4. Front-End

Abra o arquivo index.html para realizar o uso da interface de usuário no Navegador WEB

5. Documentação da API

O Swagger é utilizado para o mapeamento e documentação dos endpoints

Estrutura do Projeto

Estrutura de pastas

/api-teste-node.js
├── assets
│   ├── app.js
│   └── index.js
├── database
│   └── dados.json
├── css
│   └── style.css
├── handlers
│   └── script.js
├── js
│   └── script.js
├── swagger
|   ├── swaager_output.json
│   └── swagger.js
├── .gitignore
├── package-lock.json
├── package.json
└── index.html

Mapeamento Arquivos

• assets possui os arquivos de testes de scripts que estou testando na linguagem;
• database possui um teste para implementar o armazenamento dos dados no arquivo json dados;
• css contém o arquivo style.css com CSS básico do formulário;
• handlers é a api em Node.js com os endpoints GET, POST, PUT e DELETE de clientes;
• JavaScript faz a interação entre a API e FrontEnd contruido;
• swagger é o arquivo que gera o swagger_output.json que contém a documentacao do projeto
• index.html Arquivo principal em HTML da página, ele fará a importação dos arquivos anteriores de frontend;
• Arquivos package.json e package-lock.json são os arquivos que carregam as relação de dependências do projeto que o Node.js necessita para criar a pasta node_modules

Fluxograma do projeto

flowchart LR
    html[index.html] <--> css[css/style.css]
    html[index.html] --> js[js/script.js]
    js[js/script.js] <--> api[handler/server.js]
    html[index.html] --> docs[swagger-output.json]
    

Loading

Desenvolvimento do Projeto:

• Formulário para GET
• Formulário para POST
• Formulário para PUT
• Formulário para DELETE
• Criar um CSS para estruturar o Formulário
• Criado JavaScript para Leitura da API
• Desenvolver API com Node.js
• Desenvolver API com endpoint GET
• Desenvolver API com endpoint POST
• Desenvolver API com endpoint PUT
• Desenvolver API com endpoint DELETE