Pular para conteúdo

Organização de rotas em categorias

Criar, renomear, listar e excluir categorias em /gateway/api/v1/gateways/{gatewayId}/categories, encaminhadas pelo BFF ao Core.

%%{init: {"theme":"base","themeVariables":{"fontFamily":"Arial, sans-serif","fontSize":"16px","lineColor":"#64748b","primaryTextColor":"#172b4d"},"flowchart":{"htmlLabels":true,"useMaxWidth":true,"nodeSpacing":28,"rankSpacing":38,"padding":14,"curve":"linear","subGraphTitleMargin":{"top":12,"bottom":16}},"sequence":{"useMaxWidth":true,"actorMargin":28,"width":145,"height":45,"diagramMarginX":32,"diagramMarginY":12,"messageMargin":24,"wrap":true,"mirrorActors":false},"themeCSS":".edgeLabel, .edgeLabel p {background-color:var(--diagram-surface)!important;color:var(--diagram-text)!important}\n.cluster rect {fill:var(--diagram-group)!important;stroke:var(--diagram-line)!important}\n.cluster-label span, .cluster-label text {color:var(--diagram-text)!important;fill:var(--diagram-text)!important}\n.flowchart-link, .actor-line {stroke:var(--diagram-line)!important}\nmarker path {fill:var(--diagram-line)!important;stroke:var(--diagram-line)!important}\n.actor {fill:var(--diagram-domain)!important;stroke:var(--diagram-domain-border)!important}\ntext.actor, .messageText, .loopText, .labelText {fill:var(--diagram-text)!important}\n.messageLine0, .messageLine1, .loopLine {stroke:var(--diagram-line)!important}\n.labelBox {fill:var(--diagram-surface)!important;stroke:var(--diagram-line)!important}\n.note {fill:var(--diagram-async)!important;stroke:var(--diagram-async-border)!important}\n.noteText {fill:var(--diagram-text)!important}\n.nodeLabel, .nodeLabel p, .nodeLabel span {color:var(--diagram-text)!important}\n.node .nodeLabel, .node .nodeLabel p {font-size:17px;font-weight:600;line-height:1.4;text-align:center}\n.nodeLabel small {display:inline-block;margin-top:4px;font-size:15px;font-weight:400;line-height:1.4;color:var(--diagram-description)!important}\ntext.actor, text.actor tspan {font-size:17px;font-weight:600}\n.node.entry rect, .node.entry polygon, .node.entry path, .node.entry circle {fill:var(--diagram-entry)!important;stroke:var(--diagram-entry-border)!important}\n.node.domain rect, .node.domain polygon, .node.domain path, .node.domain circle {fill:var(--diagram-domain)!important;stroke:var(--diagram-domain-border)!important}\n.node.security rect, .node.security polygon, .node.security path, .node.security circle {fill:var(--diagram-security)!important;stroke:var(--diagram-security-border)!important}\n.node.store rect, .node.store polygon, .node.store path, .node.store circle {fill:var(--diagram-store)!important;stroke:var(--diagram-store-border)!important}\n.node.async rect, .node.async polygon, .node.async path, .node.async circle {fill:var(--diagram-async)!important;stroke:var(--diagram-async-border)!important}\n.node.external rect, .node.external polygon, .node.external path, .node.external circle {fill:var(--diagram-external)!important;stroke:var(--diagram-external-border)!important}\n text.actor tspan, .loopText tspan, .labelText tspan, .messageText tspan, .noteText tspan {fill:var(--diagram-text)!important}\n\n"}}%%
%%{init: {"sequence":{"width":180,"actorMargin":35,"messageMargin":24,"wrap":true}}}%%
sequenceDiagram
    actor A as Cliente
    participant B as BFF
    participant C as Core
    participant M as MongoDB
    A->>B: Gerenciar categorias
    B->>C: Encaminhar ação e tenant
    alt Criar ou renomear
        C->>C: Validar edição e nome no Gateway
        C->>M: Inserir ou atualizar categories
        C-->>B: 201 ou 200
    else Listar
        C->>M: Selecionar categorias da revisão
        opt expand=routes
            C->>M: Ler rotas do mesmo snapshot
        end
        C-->>B: 200 — lista
    else Excluir
        C->>C: Verificar template e upgrade
        C->>M: Marcar categoria como excluída
        C-->>B: 204
    end
    B-->>A: Resultado

Resumo: O Core verifica existência do Gateway na criação e duplicidade de nome. Na leitura, revisionId explícito pode recuperar o snapshot de metadados do template ou incluir categorias excluídas em uma revisão DEPRECATED. A expansão de rotas usa a mesma revisão.

Resultado: Categoria criada/renomeada ou excluída logicamente, preservando suporte à leitura histórica. O BFF encaminha sem o assembler de políticas.

Alternativas relevantes: Categorias de template não podem ser renomeadas/excluídas pelo fluxo comum; upgrade reservado também bloqueia escrita. A exclusão lógica conserva os documentos de rotas e suas referências.

Todos os fluxos do Core · Modelo de dados · Versionamento.

Referências de implementação

core / CategoryService

core / CategoryController

core / VersionizingRouteService

bff / CategoryForwardingService