push da documentacao da api

2025-04-02 18:18:13 -03:00
parent 4719279ab7
commit 15bb11fc4c
6 changed files with 578 additions and 337 deletions
--- a/src/data-consult/doc.html
+++ b/src/data-consult/doc.html
@@ -1,114 +0,0 @@
-<!DOCTYPE html>
-<html lang="pt-BR">
-<head>
-  <meta charset="UTF-8" />
-  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Documentação - DataConsult Module</title>
-  <style>
-    body {
-      font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
-      background-color: #f9f9f9;
-      color: #333;
-      line-height: 1.6;
-      padding: 2rem;
-    }
-    h1, h2, h3 {
-      color: #007acc;
-    }
-    code, pre {
-      background-color: #eee;
-      padding: 1rem;
-      border-radius: 4px;
-      display: block;
-      white-space: pre-wrap;
-      margin-bottom: 1rem;
-    }
-    table {
-      width: 100%;
-      border-collapse: collapse;
-      margin: 1rem 0;
-    }
-    th, td {
-      border: 1px solid #ddd;
-      padding: 0.75rem;
-    }
-    th {
-      background-color: #007acc;
-      color: white;
-    }
-    .tag {
-      display: inline-block;
-      background: #007acc;
-      color: white;
-      padding: 0.2rem 0.6rem;
-      border-radius: 4px;
-      font-size: 0.85rem;
-    }
-  </style>
-</head>
-<body>
-  <h1>📊 Módulo de Consultas - Portal Juru API</h1>
-
-  <h2>📌 Endpoints Disponíveis</h2>
-
-  <h3>🔹 GET /api/v1/data-consult/stores</h3>
-  <p><strong>Descrição:</strong> Lista todas as lojas.</p>
-  <p><strong>Autenticação:</strong> <span class="tag">JWT</span></p>
-  <code>Retorna: StoreDto[]</code>
-
-  <h3>🔹 GET /api/v1/data-consult/sellers</h3>
-  <p><strong>Descrição:</strong> Lista todos os vendedores ativos.</p>
-  <p><strong>Autenticação:</strong> <span class="tag">JWT</span></p>
-  <code>Retorna: SellerDto[]</code>
-
-  <h3>🔹 GET /api/v1/data-consult/billings</h3>
-  <p><strong>Descrição:</strong> Retorna todos os tipos de faturamento válidos.</p>
-  <p><strong>Autenticação:</strong> <span class="tag">JWT</span></p>
-  <code>Retorna: BillingDto[]</code>
-
-  <h3>🔹 GET /api/v1/data-consult/customers/:filter</h3>
-  <p><strong>Descrição:</strong> Busca clientes por nome, código ou CPF/CNPJ.</p>
-  <p><strong>Parâmetro:</strong> <code>filter</code></p>
-  <p><strong>Autenticação:</strong> <span class="tag">JWT</span></p>
-  <code>Retorna: CustomerDto[]</code>
-
-  <h3>🔹 GET /api/v1/data-consult/products/:filter</h3>
-  <p><strong>Descrição:</strong> Busca produtos por descrição, código ou código auxiliar.</p>
-  <p><strong>Parâmetro:</strong> <code>filter</code></p>
-  <p><strong>Autenticação:</strong> Não requer</p>
-  <code>Retorna: ProductDto[]</code>
-
-  <h2>🧱 Camadas e Responsabilidades</h2>
-  <table>
-    <tr><th>Camada</th><th>Responsabilidade</th></tr>
-    <tr><td>DataConsultController</td><td>Recebe as requisições HTTP e delega para o service</td></tr>
-    <tr><td>DataConsultService</td><td>Intermediário entre controller e repositório; adiciona logs e trata exceções</td></tr>
-    <tr><td>DataConsultRepository</td><td>Executa queries SQL no Oracle via TypeORM</td></tr>
-    <tr><td>LoggerService</td><td>Registra logs de acesso, sucesso ou erro</td></tr>
-  </table>
-
-  <h2>📦 Detalhes Técnicos</h2>
-  <ul>
-    <li>Utiliza <strong>Oracle</strong> como banco de dados com configuração customizada.</li>
-    <li>As buscas por cliente e produto realizam múltiplas tentativas de match (ex: por código, nome, etc.).</li>
-    <li>Repositório implementa <code>queryRunner</code> com liberação segura de conexão.</li>
-    <li>Camada de serviço registra log com <code>ILogger</code> em todas as operações.</li>
-    <li>Erros no endpoint <code>products</code> são tratados com <code>HttpException</code>.</li>
-  </ul>
-
-  <h2>🔐 Segurança</h2>
-  <p>Endpoints protegidos utilizam <code>@UseGuards(JwtAuthGuard)</code> e <code>@ApiBearerAuth()</code>.</p>
-  <p><strong>Header necessário:</strong></p>
-  <code>Authorization: Bearer &lt;token&gt;</code>
-
-  <h2>🚀 Melhorias Futuras</h2>
-  <ul>
-    <li>[🔹 ] Cache Redis para lojas, vendedores e faturamentos</li>
-    <li>[ ] Auditoria detalhada de acessos no logger</li>
-    <li>[ ] Paginação nas buscas de clientes e produtos</li>
-    <li>[ ] Endpoint para exportação dos dados em CSV</li>
-  </ul>
-
-  <p><strong>Última atualização:</strong> 29/03/2025</p>
-</body>
-</html>