Microsserviço de Pagamentos do Sistema de Gestão de Restaurantes (RMS) desenvolvido pelo grupo "BOPE" G03 da turma 4SOAT para o Tech Challenge da Pós Tech em Software Architecture da FIAP.
Important
Antes de executar o microsserviço de pagamentos, execute primeiro o microsserviço de pedidos, seguindo as instruções disponíveis no README da api de pedidos aqui.
- Baixe e instale o Node.js em https://nodejs.org/en/download
- Instale o CLI do NestJS através do comando
npm i -g @nestjs/cli - Navegue até a pasta raiz do projeto usando o Terminal;
- Faça uma cópia do arquivo
.env.templatecom o nome.enve preencha as variáveis de ambiente dentro dele; - Execute o comando
npm installpara instalar os pacotes npm; - Execute o comando
docker-compose up -d db-pagamentospara iniciar o container do banco de dados; - Use o comando
npm run startpara iniciar a aplicação. - Acesse o Swagger em http://localhost:3003/swagger/
Como executar a aplicação usando o Docker Compose?
- Clone este repositório;
- Navegue até a pasta raiz do projeto usando o Terminal;
- Faça uma cópia do arquivo
.env.templatecom o nome.enve preencha as variáveis de ambiente dentro dele; - Execute o comando
docker-compose up -d --build --force-recreate - Acesse o Swagger em http://localhost:3003/swagger/
Como executar a aplicação usando o Kubernetes do Docker Desktop?
- Clone este repositório;
- Navegue até a pasta raiz do projeto usando o Terminal;
- Use o comando
docker build -t rms-api-pagamentos:latest .para gerar a imagem de container da aplicação; - Use o comando
kubectl apply -f k8s/development/postgres/namespace.yaml -f k8s/development/postgres/pvc-pv.yaml -f k8s/development/postgres/config.yaml -f k8s/development/postgres/secrets.yaml -f k8s/development/postgres/deployment.yaml -f k8s/development/postgres/service.yamlpara fazer deploy do banco de dados; - Use o comando
kubectl apply -f k8s/development/api/namespace.yaml -f k8s/development/api/config.yaml -f k8s/development/api/secrets.yaml -f k8s/development/api/deployment.yaml -f k8s/development/api/service.yaml -f k8s/development/api/hpa.yamlpara fazer deploy da aplicação; - Acesse o Swagger em http://localhost:3003/swagger/
Para remover a aplicação do Kubernetes, use o comando
kubectl delete namespace rms
Em seu ambiente de desenvolvimento, por questão de segurança, abra os arquivos /k8s/development/postgres/secrets.yaml e /k8s/development/api/secrets.yaml na pasta /k8s/development e preencha os valores sensíveis manualmente.
No ambiente de produção os Secrets do Kubernetes são gerenciados pelo AWS Secrets Manager.
Para mais informações visite a página Boas práticas para secrets do Kubernetes.
Para testar o pagamento de pedidos usando o QR Code do Mercado Pago você vai precisar criar uma Aplicação no portal do Mercado Pago Developers.
- Siga as instruções na página Pré-requisitos no Mercado Pago Developers;
- Após criar as contas de teste do
Vendedore doComprador, abra uma janela anônima (Ctrl + Shift + P) no navegador e faça login no portal do Mercado Pago Developers usando o usuário e senha da conta de teste do Vendedor; - Após fazer login no portal do Mercado Pago Developers usando o usuário e senha da conta de teste do Vendedor, crie uma aplicação de testes dento da conta de testes do Vendedor.
- Anote o
User IDque aparece em baixo de "Detalhes da aplicação" na página inicial da aplicação de testes dentro da conta de testes do Vendedor; - Clique em "Credenciais de teste" no menu do lado esquerdo da tela e anote o
Access Tokenda aplicação de testes; - Usando o Postman, cadastre uma Loja conforme instruções na página Criar loja. Anote o
idda Loja que você cadastrou; - Usando o Postman, cadastre um Caixa conforme instruções na página Criar caixa. Anote o
external_iddo Caixa que você cadastrou; - Preencha as variáveis de ambiente no arquivo
.envcom oUser IDeAccess Tokenda aplicação de testes e com oidda Loja e oexternal_iddo Caixa que você de cadastrou anteriormente através da API do Mercado Pago; - Execute a aplicação.
Tip
Para instruções mais detalhadas visite https://github.com/dannevesdantas/poc-mercadopago
Entendemos que o modelo de documento é o que mais se adequa ao nosso problema de negócio, contexto atual e requisitos no Microsserviço de Pagamentos.
Quais são os parâmetros da conexão e credenciais para acesso ao banco de dados MongoDB?
Você pode conectar-se a instância de banco de dados MongoDB usando o MongoDB Compass, o terminal através do MongoDB Shell, ou qualquer outra IDE ou ferramenta compatível.
Host: localhost
Porta: 27017 (padrão)
Usuário: admin
Senha: pass
DB name: pagamentos
mongodb://admin:pass@db-pagamentos:27017/
A documentação do projeto está disponível no GitHub Wiki.
Architectural Pattern: Clean Architecture + Screaming Architecture
Para contribuir com o projeto consulte o guia em CONTRIBUTING.md
$ npm install# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
API de Pedidos
https://github.com/Grupo-G03-4SOAT-FIAP/rms-api-pedidos
Infrastructure as code (IaC) com Terraform
https://github.com/Grupo-G03-4SOAT-FIAP/rms-iac
Os reports de "antes" e "depois" encontram-se na pasta /docs/zap-scanning-report
Clique aqui para acessar
Como escanear a API usando o OWASP ZAP?
Para escanear todos os endpoints da API em busca de vulnerabilidades siga o passo a passo abaixo.
- Execute a aplicação usando o Docker Compose;
- Execute o comando abaixo:
docker run --name zap --network host -v $(pwd):/zap/wrk/:rw -t zaproxy/zap-stable zap-api-scan.py -t http://localhost:3003/swagger-json -f openapi -r report.htmlSubstitua os parenteses em
$(pwd)por chaves${pwd}no Windows.
O report em formato HTML será gerado no diretório atual.
Clique aqui para obter mais informações sobre o API Scan do ZAP.
Node.js v20.12.0 (LTS), Docker Desktop 24.0.6 e Kubernetes v1.28
Pagamentos processados por Mercado Pago.
