Skip to main content

Swagger

Estrutura de Pastas:

/api/
├── src/
│   ├── config/               # 📄 Configurações e definição dos endpoints no Swagger│                                                                                           

│   ├── controller/        # ⚙️ Middlewares diversos, incluindo o multer para uploads
│   │   └── otp/                                                                                                                                                                                                                                │   │   └── patrimônio/                                                                                                                                                                                                                │   │   └── setor/                                                                                                                                                                                                                            │   │   └── usuario/                                                                                                                                                                                                                       │

│   ├── docs/             # 🛣️ Definição de todas as rotas do sistema organizadas por domínio                                                                             │                                                                                                                                                                                                                                                          │   ├── media/                                                                                                                                                                                                                              │                                                                                                                                                                                                                                                         │   ├── middlewares/                                                                                                                                                                                                                   │   │   └── authFacade/                                                                                                                                                                                                                │   │   └── basicAuth/                                                                                                                                                                                                                  │   │   └── checkSetor/                                                                                                                                                                                                                 │   │   └── multer/                                                                                                                                                                                                                                                                                │   ├── router/             # 🛣️ Definição de todas as rotas do sistema organizadas por domínio
│   │   ├── otp/
│   │   ├── patrimonio/
│   │   ├── setor/
│   │   ├── usuario/
│   │   └── router.ts       # Roteador principal que importa e agrupa os módulos acima

│   ├── services/           # 🧩 Regras de negócio e funcionalidades para cada tipo de usuário
│   │   ├── avaliador/
│   │   ├── corregedor/
│   │   ├── defensor/
│   │   └── usuario/

│   ├── utils/              # 🔧 Utilitários de suporte à aplicação
│   │   ├── opt/            # Envio de OTPs e recuperação de senha
│   │   ├── pdf/            # Operações de manipulação e leitura de PDFs
│   │   ├── validations/    # Validações como token, CPF, e campos diversos
│   │   └── ...             # Outros utilitários adicionais

│   └── app.tsx             # 🎯 Ponto de entrada da aplicação e inicialização dos serviços