Como criar um catálogo de interfaces entre sistemas?

Question

IT Interview Practice · Accepted Answer

Crie um **catálogo de interfaces** como um inventário mantido dos contratos entre sistemas e de seus responsáveis. Ele conecta o diagrama arquitetural aos detalhes necessários para implementação, resposta a incidentes e planejamento de mudanças.

## Comece pelos fluxos de negócio

Percorra um processo real, como o atendimento de pedidos, e liste cada chamada de API, evento, transferência de arquivo e troca de dados agendada. Inclua caminhos menos visíveis, como exportações de conciliação e importações manuais de recuperação.

Para cada interface, registre:

- Um identificador estável, finalidade de negócio, produtor, consumidores e contatos responsáveis.
- Direção, transporte, endpoint ou localização do arquivo e vínculo com o schema versionado.
- Responsabilidade pelos dados, identificadores, classificação e mecanismo de acesso, sem armazenar credenciais.
- Temporização ou agenda, volume esperado, limites de payload e expectativas de serviço acordadas.
- Regras de timeout, repetição, duplicatas, ordenação e tratamento de erros, quando aplicáveis.
- Monitoramento, escalonamento, política de compatibilidade e dependências de desativação.

## Exemplo de registro

A interface IF-07 envia confirmações de expedição de um armazém para uma plataforma de pedidos a cada 15 minutos. O armazém é responsável pelo envio; a plataforma, pela ingestão. O contrato define um identificador de expedição, versão de schema, contagem de registros e arquivo de confirmação. Confirmações ausentes são encaminhadas a uma equipe de suporte identificada.

Isso é mais útil que uma seta chamada “integração”: permite identificar se uma atualização de expedição atrasada resulta de falha de transporte, dados rejeitados ou execução agendada perdida.

## Mantenha o catálogo confiável

Vincule schemas e runbooks em vez de duplicar seus conteúdos. Atualize o catálogo quando uma interface mudar e compare-o periodicamente com o tráfego observado e os trabalhos agendados. Um inventário estático rapidamente deixa de registrar conexões não oficiais.

## Armadilha na entrevista

Uma lista de endpoints, sozinha, não descreve um contrato. Uma boa resposta inclui significado de negócio, responsabilidade e comportamento em falhas, escolhendo um nível de detalhe que permita manutenção.

Comece pelos fluxos de negócio

Exemplo de registro

Mantenha o catálogo confiável

Armadilha na entrevista

Perguntas relacionadas