Para a preparar o ambiente é necessário instalar algumas ferramentas para dar continuidade ao desenvolvimento, as ferramentas que devem ser intaladas são as seguintes:
Baixe o Node.js na versão xx.xxx Após baixado, instalado abra o PowerShell e verifique a versão executando
node -v Verifique se o gerenciador de pacotes npm foi instalado também, execute
npm -v Baixe o Git na versão 2.32.0.2 Após baixado, instalado abra o PowerShell e verifique a versão executando
git --version Abra um terminal e vá para o diretório onde pretende baixar o projeto e execute para baixar todos os arquivos necessários para execução do projeto
git clone https://github.com/vittoi/c2-p2FeedbacksBaixe o Mongo na versão 01.35.0 Após baixado, instalado execute o MongoCompass e import a conexão clicando em connect no canto superior esquerdo da tela, e depois na opção 'import saved connections'
vá ao diretório onde o projeto foi instalado e no diretório .\banco selecione o arquivo connection.json
Agora que já temos a conexão configurada, clique na nova conexão e deois em connect.
Para importar cada collection abra a opção extensão, clique em uma collection e depois na opção Add Data
Ao clicar em import file se direcione para o diretório ./banco\collections e selecione o arquivo com o mesmo nome da collection
repita o processo para todas as collections.
Já temos todos os arquivos do projeto local, agora precisamos intalar as dependencias para que se consiga começar os testes.
Para instalar as depencias da API, abra o PowerShell como administrador e se direcione a pasta ./REST, execute
npm installO ambiente do back-end já está preparado, sempre que for usar os serviços execute a aplicação com os seguintes comandos
# watch mode
npm run start:dev
# production mode
npm run start:prodPara instalar as depencias do front-end, abra o PowerShell como administrador e se direcione a pasta ./FRONT, execute
npm installDepois de terminar a instalação de todas as dependencias você pode executar o projeto com o seguinte comando
npm startAbra locahost no seu Browser para visualizar.
A página irá recarregar quando ao salvar mudanças.
Antes de fazer os testes veja uma breve explicação dos termos usados neste ambiente e como eles podem ser utilizado.
Baixe o Postman na versão xx.xxx
Após baixado e instalado abra o Postman.
O método GET é usado para solicitar recursos de um servidor e não deve alterar o estado do servidor ou do recurso solicitado. Ele é seguro e repetível, o que significa que a mesma solicitação pode ser feita várias vezes sem causar efeitos colaterais.
O método POST é usado para enviar dados para um servidor, permitindo a modificação do estado do servidor ou do recurso solicitado. Não é seguro ou repetível e é usado em formulários web e upload de arquivos.
O método PUT é usado para atualizar um recurso existente em um servidor. Ele envia os dados atualizados para substituir completamente o recurso existente e é idempotente, o que significa que uma solicitação PUT pode ser repetida várias vezes sem alterar o resultado ou o estado do servidor. É usado em APIs RESTful para atualizar recursos existentes.
O método DELETE é usado para remover um recurso existente em um servidor. Ele solicita que o servidor remova completamente o recurso especificado e é idempotente, o que significa que uma solicitação DELETE pode ser repetida várias vezes sem alterar o resultado ou o estado do servidor. É comumente usado em APIs RESTful para remover recursos existentes.
Um endpoint em REST é a URL específica usada para acessar um recurso ou serviço em um servidor através de uma API RESTful. Cada endpoint é definido por um método HTTP específico e geralmente inclui parâmetros que definem qual recurso está sendo acessado e o que deve ser feito com ele.
Os cabeçalhos HTTP são informações adicionais enviadas junto com uma solicitação ou resposta HTTP. Eles fornecem informações sobre o tipo de conteúdo, a versão do protocolo HTTP, autenticação e outros detalhes que ajudam a controlar o comportamento da solicitação ou resposta. Eles são importantes para garantir que as solicitações e respostas sejam interpretadas corretamente pelos servidores e clientes.
Os verbos são mapeados nos arquivos .controller, ou seja o controller vai ser o primeiro lugar a executar quando houver uma requisição, assim tudo que aquela ação deve fazer deve começar ali e obedecer os padrões da arquitetura utilizada.
A URL base é https://localhost:3030/
Para criar um novo endpoint na aplicação consultar NEST docs
Aqui você vai encontrar mais informações e boas práticas no padrão REST
Para executar uma requisição escolha o verbo(No exemplo abaixo o selecionado é o GET) que deseja e insira a URL padrão concatenada com o endpoint que deseja.
