Esta é uma API REST desenvolvida em JavaScript com Node.js para cadastrar e gerenciar instrutores e aulas. Ela utiliza o arquivo bancodedados.js para armazenar os dados de forma síncrona e possui rotas implementadas para os verbos POST, GET, PATCH e DELETE.
Certifique-se de ter o Node.js e o NPM instalados em sua máquina. Você pode verificar se o Node.js e o NPM estão instalados executando os seguintes comandos no terminal:
- node -v
- npm -v
Se não estiverem instalados, você pode baixá-los em nodejs.org (o NPM é instalado automaticamente com o Node.js).
Clone este repositório em sua máquina.
Navegue até o diretório do projeto.
Instale as dependências, incluindo o framework Express, utilizando o NPM:
- npm install express
Certifique-se de que o servidor está em execução. Você pode iniciar o servidor com o seguinte comando ou instalar o NODEMON para não precisar ficar startando a cada alteração no codigo.
A API estará disponível em http://localhost:3000. Pode utilizar o INSOMNIA ou outra interface de seu interesse para facilitar o acesso a API REST e testar as rotas.
O trecho do codigo do arquivo que contém as rotas que esta no arquivo rotas.js onde estão definidos os parametros de acesso e conexão com o controlador onde estão definidas as rotinas de cadatro, aatualização, exclução e validações.
Por questões acadêmicas não utilizei "destructuring" (desestruturação) nas definições das rotas.
Abaixo telas de exemplo de consulta, cadastro, alteração e exclusão de um instrutor:
- Listar Instrutores cadastrados:
- Cadastrar novo Instrutor:
- Alterar Instrutor de ID 1:
- Consultar Instrutor por ID:
- Excluir um Instrutor passando o ID:
- As telas acima são exemplos da manipução dos objetos utilizando a interface INSOMNIA para manipular os dados. O arquivo raiz tem a implementações das aulas vinculadas aos intrutores que funcionam com a mesma lógica. Basta se basear pelas seguir conforme as rotas do arquivo rotas.js para implementa-las no Insominia para testar a aplicação.
Se desejar contribuir com este projeto, sinta-se à vontade para abrir um problema ou enviar uma solicitação de pull request.
Este projeto foi construido baseado em conteúdos acadêmicos em conjunto com a escola tecnologica Cubos Academy.
Espero que este README seja útil para servir de consulta e apoio para iniciantes. Boa sorte com o desenvolvimento da sua API!