Início

Documentação técnica completa para desenvolvedores do ecossistema Santa Mão

Sobre o Projeto

O SantaMão Core API é a espinha dorsal do ecossistema Santa Mão, uma plataforma que conecta profissionais qualificados a clientes que necessitam de serviços especializados. Esta documentação foi criada para auxiliar desenvolvedores a entenderem a arquitetura, padrões e práticas utilizadas no projeto.

Objetivo desta Documentação

Esta documentação serve como guia completo para:

Desenvolvedores Backend: Compreender a arquitetura, padrões de design e implementação da API
Desenvolvedores Frontend: Entender os contratos, endpoints e fluxos de integração
DevOps: Configurar ambientes, deploy e monitoramento
Arquitetos: Revisar decisões arquiteturais e padrões aplicados

Arquitetura do Sistema

O Santamão Core API foi desenvolvido seguindo princípios de clean architecture, utilizando os seguintes padrões:

Padrões Implementados

CQRS (Command Query Responsibility Segregation): Separação clara entre operações de leitura e escrita
DDD (Domain-Driven Design): Modelagem orientada ao domínio de negócio
Event-Driven Architecture: Comunicação assíncrona baseada em eventos
Outbox Pattern: Garantia de consistência eventual
Internal Trusted Authentication: Autenticação entre serviços internos

Entidades

Documentação dos principais entidades do sistema:

User Aggregate: Gerenciamento de usuários do sistema
Professional User Aggregate: Profissionais cadastrados na plataforma
Order Aggregate: Pedidos de serviços
Request Aggregate: Solicitações e requisições
Job Aggregate: Trabalhos e agendamentos
Cities: Gerenciamento de cidades
Skills: Habilidades e competências
Discounts: Sistema de descontos
Notification Templates: Templates de notificações

Atualizações

Esta documentação é mantida atualizada com as últimas mudanças do sistema. Verifique o histórico de commits para acompanhar as atualizações recentes.

Versão da Documentação: 1.0
Última Atualização: Novembro 2025
Mantido por: Equipe de Arquitetura Santa Mão