Wish List

Esta é um API que consiste em cadastrar, deletar, atualizar e listar Clientes. Essa API também conta com uma Wish List, onde o Cliente pode adicionar qualquer produto existente que provém da API do Magalu. O cliente pode ter apenas uma Wish List, e cadastrar apenas produtos que ainda não existem em sua lista.

Instalação

Para instalar o projeto em sua máquina, primeiramente certifique-se de ter instalado em sua maquina:

• Node v15.8
• docker-compose

Agora você precisa configurar as variáveis de ambiente do projeto

• Copie tudo que está dentro do arquivo .env.example que se encontra na raiz do projeto,
• Crie um novo arquivo chamado .env na raiz do projeto
• Cole tudo que está dentro do .env.example no .env

Precisamos subir o banco de dados

O banco utilizado nesse projeto foi o postgresSQL

Baixe a imagem necessária, com o comando:

docker pull postgres

Rode o docker-compose

  docker-compose up

Dê um start no container

  docker-compose start

Rode:

  npm install

Esse projeto esta trabalhando com versionamento de alterações no banco de dados, então você precisa rodar as migrations:

  npm run migration:run

Agora vamos rodar o projeto efetivamente

  npm run dev:server

Voce poderá acessar o projeto em http://localhost:3333

Documentação

Aperte para da fork, após abrir o link

Autenticação

Essa API é aberta ao mundo, mas ela precisa de autenticação para acessar as rotas:

Para se autenticar você precisa acessar a rota /auth

POST

• Exemplo de request

{
  "username": "luizalabs",
  "password": "luizalabs2021"
}

• Exemplo de resposta

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE2MzI0OTg5NzUsImV4cCI6MTYzMjU4NTM3NSwic3ViIjoibHVpemFsYWJzIn0.Qh3F5Q5JuSnPM9Ukxqyi5edZMBzInyEmk9PdYFeoUFQ"
}

Pronto você está autorizado!! Use esse token no HEADER da sua request, como

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE2MzI0OTg5NzUsImV4cCI6MTYzMjU4NTM3NSwic3ViIjoibHVpemFsYWJzIn0.Qh3F5Q5JuSnPM9Ukxqyi5edZMBzInyEmk9PdYFeoUFQ

• O restante da documentação esta em collection criada no postman, e você pode ter exemplos de paylod de requests e reponses, como abaixo:

Badges