Jak vytvoříte katalog rozhraní mezi systémy?

Question

IT Interview Practice · Accepted Answer

Vytvořte **katalog rozhraní** jako udržovaný inventář kontraktů mezi systémy a jejich vlastníků. Propojuje architektonický diagram s podrobnostmi, které týmy potřebují pro implementaci, řešení incidentů a plánování změn.

## Začněte obchodními toky

Projděte skutečný proces, například vyřízení objednávky, a sepište každé volání API, událost, přenos souboru a plánovanou výměnu dat. Zahrňte méně viditelné cesty, například exporty pro odsouhlasení a ruční importy při obnově.

U každého rozhraní zaznamenejte:

- Stabilní identifikátor, obchodní účel, producenta, konzumenty a odpovědné kontakty.
- Směr, transport, endpoint či umístění souboru a odkaz na verzované schéma.
- Vlastnictví dat, identifikátory, klasifikaci a přístupový mechanismus bez ukládání přihlašovacích údajů.
- Časování či harmonogram, očekávaný objem, limity datového obsahu a dohodnutá očekávání služby.
- Pravidla timeoutů, opakování, duplicit, pořadí a zpracování chyb tam, kde se uplatňují.
- Monitoring, eskalaci, zásady kompatibility a závislosti při vyřazení.

## Příklad položky

Rozhraní IF-07 odesílá každých 15 minut potvrzení expedice ze skladu na objednávkovou platformu. Sklad vlastní datový kanál; objednávková platforma vlastní příjem. Kontrakt definuje identifikátor zásilky, verzi schématu, počet záznamů a potvrzovací soubor. Chybějící potvrzení se eskalují jmenovanému týmu podpory.

To je užitečnější než šipka označená „integrace“: tým může určit, zda opožděnou aktualizaci zásilky způsobila chyba transportu, odmítnutá data nebo nedodržený harmonogram.

## Udržujte katalog spolehlivý

Odkazujte na schémata a provozní příručky místo duplikace jejich obsahu. Aktualizujte katalog při změně rozhraní a pravidelně jej porovnávejte s pozorovaným provozem a plánovanými úlohami. Statický inventář rychle přestane zachycovat neoficiální propojení.

## Úskalí při pohovoru

Samotný seznam endpointů nepopisuje kontrakt. Silná odpověď zahrnuje obchodní význam, vlastnictví a chování při selhání a přitom volí udržitelnou míru podrobností.

Začněte obchodními toky

Příklad položky

Udržujte katalog spolehlivý

Úskalí při pohovoru

Související otázky