{"id":29127793,"url":"https://github.com/reginaldohiss/dict-simulator","last_synced_at":"2026-04-09T11:02:46.122Z","repository":{"id":301491898,"uuid":"1009415795","full_name":"reginaldohiss/dict-simulator","owner":"reginaldohiss","description":"Simula o DICT do Banco Central (BACEN), permitindo cadastro, consulta, atualização e desativação de chaves Pix. API construída com Node.js e MongoDB, validações robustas, arquitetura modular, testes automatizados e documentação Swagger.","archived":false,"fork":false,"pushed_at":"2025-06-27T05:30:01.000Z","size":8,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-27T06:27:35.648Z","etag":null,"topics":["express","jest","mongodb","mongose","nodejs","supertest","swagger"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/reginaldohiss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-27T05:15:24.000Z","updated_at":"2025-06-27T05:34:15.000Z","dependencies_parsed_at":"2025-06-27T06:27:38.208Z","dependency_job_id":"d84354af-49e7-4e35-96cf-af87da96ee07","html_url":"https://github.com/reginaldohiss/dict-simulator","commit_stats":null,"previous_names":["reginaldohiss/dict-simulator"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/reginaldohiss/dict-simulator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reginaldohiss%2Fdict-simulator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reginaldohiss%2Fdict-simulator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reginaldohiss%2Fdict-simulator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reginaldohiss%2Fdict-simulator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reginaldohiss","download_url":"https://codeload.github.com/reginaldohiss/dict-simulator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reginaldohiss%2Fdict-simulator/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267578003,"owners_count":24110351,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-28T02:00:09.689Z","response_time":68,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["express","jest","mongodb","mongose","nodejs","supertest","swagger"],"created_at":"2025-06-30T01:01:54.301Z","updated_at":"2025-12-30T21:56:56.707Z","avatar_url":"https://github.com/reginaldohiss.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 💸 Simulador de DICT (API Pix)\n\nAPI profissional desenvolvida com **Node.js + MongoDB** para simular o comportamento do **DICT** — o Diretório de Identificadores do sistema Pix. Permite criar, consultar, atualizar e desativar chaves Pix de forma segura, validada e documentada.\n\n---\n\n## 📌 Tabela de Conteúdo\n\n- [📚 Sobre o Projeto](#-sobre-o-projeto)\n- [📁 Estrutura do Projeto](#-estrutura-do-projeto)\n- [🚀 Tecnologias Utilizadas](#-tecnologias-utilizadas)\n- [🔧 Instalação e Execução](#-instalação-e-execução)\n- [📮 Endpoints da API](#-endpoints-da-api)\n- [🔒 Validações de Entrada](#-validações-de-entrada)\n- [📘 Documentação Swagger](#-documentação-swagger)\n- [✅ Testes Automatizados](#-testes-automatizados)\n- [📂 Estrutura Modular](#-estrutura-modular)\n- [📄 Licença](#-licença)\n\n---\n\n## 📚 Sobre o Projeto\n\nO projeto tem como objetivo simular uma API DICT semelhante à usada pelo Banco Central no Pix, permitindo o gerenciamento de chaves de identificação como CPF, e-mail, telefone e chave aleatória.\n\n---\n\n## 📁 Estrutura do Projeto\n\n```\ndict-simulator/\n├── src/                        # Código-fonte da API\n│   ├── app/\n│   │   ├── controllers/        # Lógica de controle de rotas\n│   │   ├── formRequests/       # Validações de entrada\n│   │   ├── repositories/       # Acesso a dados\n│   │   ├── resources/          # Respostas e formatação\n│   │   ├── services/           # Lógica de negócios\n│   ├── models/                 # Modelos de dados\n│   ├── routes/                 # Definição das rotas\n│   ├── docs/                   # Documentação Swagger\n│   └── app.js                  # Arquivo de configuração principal\n├── tests/                      # Testes automatizados\n├── .env                        # Arquivo de configuração de ambiente (excluído do Git)\n├── .gitignore                  # Ignorar arquivos não necessários\n├── README.md                   # Documentação principal\n├── jest.config.js             # Configuração do Jest\n├── server.js                   # Arquivo para inicializar o servidor\n└── package.json                # Dependências e scripts do projeto\n```\n\n---\n\n## 🚀 Tecnologias Utilizadas\n\n- [Node.js](https://nodejs.org/)\n- [Express.js](https://expressjs.com/)\n- [MongoDB](https://www.mongodb.com/)\n- [Mongoose](https://mongoosejs.com/)\n- [Joi](https://joi.dev/) – Validações robustas\n- [Swagger](https://swagger.io/) – Documentação\n- [Jest](https://jestjs.io/) + [Supertest](https://github.com/visionmedia/supertest) – Testes automatizados\n\n---\n\n## 🔧 Instalação e Execução\n\n### 1. Clone o repositório:\n\n```bash\n  git clone https://github.com/reginaldohiss/dict-simulator.git\n  cd dict-simulator\n```\n\n### 2. Instale as dependências:\n\n```bash\n  npm install\n```\n\n### 3. Configure o ambiente:\n\nCrie o arquivo `.env` ou renomear o `.env.example` com:\n\n```env\nPORT=3000\nMONGO_URI=mongodb://localhost:27017/dict-simulator\n```\n\n### 4. Inicie a aplicação:\n\n```bash\n  npm run dev\n```\n\nAcesse: `http://localhost:3000/api`\n\n---\n\n## 📮 Endpoints da API\n\n| Método | Rota               | Descrição                      |\n|--------|--------------------|--------------------------------|\n| POST   | `/api/dict`        | Criar nova chave Pix           |\n| GET    | `/api/dict/:chave` | Buscar chave Pix específica    |\n| GET    | `/api/dict?nome=João`| Listar chaves por nome         |\n| PUT    | `/api/dict/:chave` | Atualizar dados de uma chave   |\n| DELETE | `/api/dict/:chave` | Desativar uma chave Pix        |\n\n---\n\n## 🔒 Validações de Entrada\n\nValidações garantidas por [Joi](https://joi.dev/):\n\n- **E-mail**: formato válido (`usuario@dominio.com`)\n- **Telefone**: formato E.164 (`+5511987654321`)\n- **CPF**: regex padrão (`000.000.000-00`)\n- **Aleatória**: UUID v4\n- Chave única\n- Agência: 4 dígitos\n- Conta: formato padrão brasileiro\n\n---\n\n## 📘 Documentação Swagger\n\nAcesse:\n\n```\nhttp://localhost:3000/api/docs\n```\n\nDisponível com interface gráfica para testar e entender todos os endpoints da API.\n\n---\n\n## ✅ Testes Automatizados\n\nRodar todos os testes:\n\n```bash\n  npm run test\n```\n\nUtiliza:\n\n- **MongoDB In-Memory**: sem afetar seu banco local\n- **Jest** + **Supertest**: integração real da API\n\nTestes incluídos:\n- Criação de chave Pix\n- Duplicidade\n- Formato inválido\n- Consulta de chaves\n\n---\n\n## 📂 Estrutura Modular\n\nA arquitetura segue princípios profissionais:\n\n- **Controller**: recebe requisições\n- **FormRequest**: valida entradas\n- **Service**: lógica de negócio\n- **Repository**: acesso ao banco\n- **Resource**: formatação de respostas\n\nSeparação de responsabilidades clara, ideal para crescimento e manutenção.\n\n---\n\n## 📄 Licença\n\nDistribuído sob a licença MIT. Consulte `LICENSE` para mais detalhes.\n\n---\n\n\u003e Desenvolvido com 💼 foco para desafios técnicos de alto nível.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freginaldohiss%2Fdict-simulator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freginaldohiss%2Fdict-simulator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freginaldohiss%2Fdict-simulator/lists"}