Implementações realizadas

• Adicionei um controller no módulo App chamado Order, juntamente com seu respectivo service e validators
• Adicionei um endpoint para criação de novo pedido POST(/api/app/order)
• Configurei rotas para iniciarem com /app
• Criei novas models para criação de orders e consequentemente suas respectivas migrations seeds e interfaces
• Criei arquivo de tests para o novo service (order.spec.ts)
• Configurei o endpoint /api/app/profile para trazer os pedidos do usuário logado (eager load)
• Adicionei configurações do sonar-qube ao projeto
• Adicionei as bibliotecas commitzen e cz-conventional-changelog para padronização das mensagens de commit e geração automátizada do CHANGELOG.md

Modelo ER implementado

Criei uma tabela Order que armazena os pedidos feitos pelos usuários, esta tabela esta ligada a uma tabela ItemOrder que correlaciona o produto com o pedido, registrando seu preço de venda e quantidade que são independentes dos preços dos produtos, visto que estes podem mudar. Além disso cada pedido possui um status que é definido através de um enum.

Testando as implementações

• Suba os containers com o comando docker-compose up é possivél que durante a primeira execução ele imprima alguns erros ao tentar inserir as seeds de produtos pois existe uma restrição de banco que não permite dois produtos com o mesmo nome, como são gerados aleatóriamente a repetição pode ocorrer, basta ignorar estes erros pois o importante aqui é termos pelo menos 1 produto para testarmos
• Faça login excutando o seguinte request:

curl --location --request POST 'http://localhost:3000/api/admin/auth/login' \
--header 'Content-Type: application/json' \
--data-raw '{
	"email": "admin@waproject.com.br",
	"password": "senha@123"
}'

Guarde o token retornado, ele será necessário nos próximos requests

• Crie um novo pedido passando no body as seguintes informações:

{
  "items": [
    {
      "quantity": quantidade deste produto,
      "price": preço de compra, pode ser diferente do preço do produto,
      "productId": ID do produto comprado,
    }
  ],
  "userId": Opcional, a api se encarrega de preencher através das informações do usuário logado
}

• Execute o request abaixo para ver seu pedido

curl --location --request GET 'http://localhost:3000/api/app/profile' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZW1haWwiOiJhZG1pbkB3YXByb2plY3QuY29tLmJyIiwiZmlyc3ROYW1lIjoiV2FQcm9qZWN0IiwibGFzdE5hbWUiOiJBZG1pbiIsInJvbGVzIjpbInN5c0FkbWluIl0sInR5cGUiOjAsImV4cCI6MTYyNjc2MTg2MywiaWF0IjoxNjI2NzMzMDYzfQ.lPUSp9vJYB4lWK3f7zBLkPTsx2OuPzqgOoxgYKD11ag'

Lembre-se de alterar o Bearer token pelo token recebido no login

• Execute o seguinte request para ver os produtos cadastrados, observe que seu estoque é alterado a medida que novas orders são geradas

curl --location --request GET 'http://localhost:3000/api/app/product?page=0&pageSize=10&orderDirection=asc&orderBy=id' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZW1haWwiOiJhZG1pbkB3YXByb2plY3QuY29tLmJyIiwiZmlyc3ROYW1lIjoiV2FQcm9qZWN0IiwibGFzdE5hbWUiOiJBZG1pbiIsInJvbGVzIjpbInN5c0FkbWluIl0sInR5cGUiOjAsImV4cCI6MTYyNjc2MTg2MywiaWF0IjoxNjI2NzMzMDYzfQ.lPUSp9vJYB4lWK3f7zBLkPTsx2OuPzqgOoxgYKD11ag'

Swagger

Maiores informações podem ser encontradas no endpoint /swagger que contém toda a documentação da API, tanto das rotas anteriores quanto das criadas nesta implementação

WaProject Api Base

Utilize o VSCode, já está configurado com sugestão de extensões e debug.

Tecnologias

• Node/Typescript
• NestJs (Framework)
• Docker
• Objection (ORM) / Knex (Query builder e migrations)
• Mailgun (envio de email)
• AWS (envio de email/s3)
• JWT (tokens)
• Bcrypt (criptografia para senhas)
• Sentry.io (log de erros)
• Pug (templates de email)

Iniciando um novo projeto

# install docker https://docs.docker.com/install

git clone git@bitbucket.org:waprojectbase/waproject-base-api.git
yarn install # ou npm install

node ./init.js

[sudo] docker-componse up
# levantará o docker com o banco de dados e a aplicação.
# Ele aplicará as migrations/seeds do banco e depois dará watch nos arquivos
# e iniciará o node com a api

Para mais informações veja a pasta ./docs