CaioZamana / back-end-ts-nestjs-mongodb-teacher

O projeto consiste em uma API REST desenvolvida com o framework Nest.js, que utiliza o MongoDB para integração e armazenamento de dados. Esta API fornece endpoints para realizar operações CRUD (Create, Read, Update, Delete) sobre os dados de professores em um sistema de gerenciamento.

Projeto: API Rest de um Crud para um Sistema de Gerenciamento de Professores utilizando Mongodb

Sobre o Projeto

Este projeto utiliza o Nest.js, um framework para construção de aplicativos Node.js eficientes e escaláveis.

Banco de Dados

Para este projeto, é utilizado um banco de dados MongoDB hospedado no cloud.mongodb.com. Este é um servidor online que permite a criação gratuita de um banco de dados simples. Caso seu sistema cresça, pode ser interessante migrar seu banco de dados para serviços mais robustos, como a AWS, por exemplo, ou mesmo utilizar uma versão paga.

Instalação

Instale o NestJS CLI globalmente executando o seguinte comando: npm install -g @nestjs/cli

Criando um novo projeto NestJS executando o seguinte comando: nest new back-end-ts-nestjs-mongodb-teacher

Para instalar as dependências do projeto, é necessário primeiro instalar o Mongoose, que é uma biblioteca do Node.js para modelagem de objetos MongoDB. Execute o seguinte comando:

npm install --save mongoose @nestjs/mongoose

Criando a Estrutura do Projeto

A estrutura do projeto pode ser definida da seguinte maneira:

1. Criando o Módulo Teacher nest g module teacher

2. Criando o Controlador Teacher nest g controller teacher

3. Criando o Serviço Teacher nest g service teacher

Executando o Projeto

Para iniciar o projeto, execute o seguinte comando:

npm start

Este comando irá iniciar o servidor e seu aplicativo estará pronto para uso.

A API Teacher permite realizar operações CRUD (Create, Read, Update, Delete) em registros de professores.

Endpoints

GET /teacher

Retorna todos os professores cadastrados.

Exemplo de uso: curl localhost:3000/teacher

POST /teacher

Cria um novo registro de professor.

Exemplo de uso: curl -X POST -H "Content-Type: application/json" -d '{ "nome": "Nome do Professor", "nRegistro": "12345", "modulo": "A" }' localhost:3000/teacher

PUT /teacher/:id

Atualiza as informações de um professor existente com o ID especificado.

Exemplo de uso: curl -X PUT -H "Content-Type: application/json" -d '{ "nome": "Novo Nome", "nRegistro": "54321", "modulo": "B" }' localhost:3000/teacher/ID_DO_PROFESSOR

DELETE /teacher/:id

Remove o registro de um professor com o ID especificado.

Exemplo de uso: curl -X DELETE localhost:3000/teacher/ID_DO_PROFESSOR