Gestão e Ciclo de Vida
O Console de Gestão é o núcleo administrativo da plataforma, responsável por centralizar a governança, a organização estrutural e o controle de evolução de todos os ativos de integração.
Hierarquia de Ativos
Section titled “Hierarquia de Ativos”A organização de recursos dentro do Console obedece a uma estrutura hierárquica estrita composta por quatro níveis:
Projeto ──► Pacote ──► Fluxo ──► Versão1. Projetos
Section titled “1. Projetos”Representam o contêiner de nível mais alto para agrupamento macro de domínios de negócio ou sistemas integrados.
-
Atributos: Nome, código único (UUID), slug amigável, descrição e documentação de suporte em formato Markdown (
README.md). -
Operações do Console: Criação, edição de metadados, atualização de documentação técnica (
README.md), exclusão e suporte a filtros de busca paginados.
2. Pacotes
Section titled “2. Pacotes”Subdivisões dentro de um projeto projetadas para agrupar fluxos que compartilham contexto funcional ou pertencem ao mesmo módulo.
-
Atributos: Nome, código único (UUID), descrição e slug.
-
Composição do Endpoint: O slug do pacote é um elemento obrigatório na construção da URL de invocação pública do fluxo.
-
Validação: O Console impede a alteração do slug do pacote caso existam publicações ativas vinculadas a ele.
3. Fluxos
Section titled “3. Fluxos”Entidades abstratas que representam o pipeline ou processo de integração específico.
-
Atributos: Nome, código único (UUID), descrição, slug e o Inicializador HTTP (
GET,POST,PUT,DELETE,PATCH). -
Construção de Rota: O slug do fluxo se une aos slugs de Projeto e Pacote para formar o endpoint REST final consumido pelos clientes.
-
Validação de Alteração: Mudanças no slug ou no inicializador HTTP são bloqueadas pelo Console se houver versões do fluxo publicadas em ambientes.
4. Versões
Section titled “4. Versões”A implementação concreta e física de um fluxo de integração em um determinado momento do tempo.
-
Atributos: Tag de identificação (string livre, ex:
1.0.0,v2-beta), comentário, modelo visual e estado do ciclo de vida. -
Versionamento Semântico: Permite coexistência de múltiplas implementações de um mesmo fluxo, viabilizando evolução contínua sem quebrar contratos legados.
Ciclo de Vida da Versão
Section titled “Ciclo de Vida da Versão”O ciclo de vida de uma versão determina a sua maturidade e regula os tipos de edição e operações permitidos pelo Console. A transição é gerenciada através de três estados estritos:
┌──────────┐ Criação do Modelo Visual ┌──────────────────┐│ CRIADO │ ───────────────────────────────► │ DESENVOLVIMENTO │└──────────┘ └────────┬─────────┘ │ │ Finalização da │ Estrutura BPMN ▼ ┌──────────────────┐ │ PRONTO │ └──────────────────┘1. Estado CRIADO
Section titled “1. Estado CRIADO”-
Definição: Estado inicial da versão assim que é instanciada no Console.
-
Regras de Publicação: Não permite publicação em nenhum ambiente.
-
Operações Permitidas: Atualização de comentários e exclusão lógica da versão.
2. Estado DESENVOLVIMENTO
Section titled “2. Estado DESENVOLVIMENTO”-
Transição: A versão assume este estado automaticamente assim que um novo modelo visual (diagrama) é instanciado ou importado.
-
Permissões de Alteração: Permite modificação irrestrita da estrutura visual do fluxo (adição, remoção, alteração de etapas e destinos).
-
Regras de Publicação: Permite publicação em ambientes. Essa capacidade possibilita fluxos de trabalho ágeis, permitindo que desenvolvedores façam deploy e realizem testes funcionais dinâmicos em ambientes de desenvolvimento ou homologação sem congelar a versão.
3. Estado PRONTO
Section titled “3. Estado PRONTO”-
Transição: Promovido manualmente pelo desenvolvedor através do Console ao sinalizar a conclusão do desenvolvimento do modelo visual.
-
Restrição de Modelo: A estrutura gráfica do fluxo (etapas e destinos) fica congelada e imutável.
-
Regras de Publicação: Permite publicação em qualquer ambiente (incluindo produção).
Matriz de Mutabilidade por Estado
Section titled “Matriz de Mutabilidade por Estado”A tabela a seguir consolida o que pode ou não ser alterado no Console de acordo com o estado atual da versão:
| Recursos / Operações | State: CRIADO |
State: DESENVOLVIMENTO |
State: PRONTO |
|---|---|---|---|
| Pode ser Publicado? | ❌ Não | Sem Restrição | Sem Restrição |
| Modelo Visual (Diagrama BPMN) | ❌ Indisponível | Liberação Total | 🔒 Congelado / Imutável |
| Variáveis de Ambiente | ❌ Não | Permite Alteração | Permite Alteração |
| Adaptadores (Entrada/Saída) | ❌ Não | Permite Alteração | Permite Alteração |
| Segurança (API Keys e CORS) | ❌ Não | Permite Alteração | Permite Alteração |
| Configuração de Agendamentos | ❌ Não | Permite Alteração | Permite Alteração |
| Exclusão Lógica da Versão | Permite Exclusão | 🔒 Bloqueado se publicado | 🔒 Bloqueado se publicado |