Hur bygger du en katalog över gränssnitt mellan system?

Question

IT Interview Practice · Accepted Answer

Bygg en **gränssnittskatalog** som en underhållen förteckning över kontrakt mellan system och deras ägare. Den kopplar arkitekturdiagrammet till detaljer som team behöver för implementation, incidenthantering och förändringsplanering.

## Börja med verksamhetsflöden

Gå igenom en verklig process, exempelvis orderleverans, och lista varje API-anrop, händelse, filöverföring och schemalagt datautbyte. Ta med mindre synliga flöden som avstämningsexporter och manuella återställningsimporter.

Dokumentera för varje gränssnitt:

- En stabil identifierare, verksamhetssyfte, producent, konsumenter och ansvariga kontakter.
- Riktning, transport, endpoint eller filplats och länk till versionshanterat schema.
- Dataägarskap, identifierare, klassificering och åtkomstmekanism, utan att lagra autentiseringsuppgifter.
- Tidsegenskaper eller schema, förväntad volym, payloadgränser och överenskomna tjänsteförväntningar.
- Regler för timeout, återförsök, dubbletter, ordning och felhantering där det är relevant.
- Övervakning, eskalering, kompatibilitetspolicy och avvecklingsberoenden.

## Exempelpost

Gränssnitt IF-07 skickar leveransbekräftelser från ett lager till en orderplattform var 15:e minut. Lagret äger flödet; orderplattformen äger inläsningen. Kontraktet definierar leveransidentifierare, schemaversion, antal poster och kvittensfil. Saknade kvittenser eskaleras till ett namngivet supportteam.

Detta är mer användbart än en pil märkt ”integration”: teamet kan avgöra om en försenad leveransuppdatering beror på transportfel, avvisade data eller en missad schemakörning.

## Håll katalogen tillförlitlig

Länka till scheman och driftinstruktioner i stället för att kopiera innehållet. Uppdatera katalogen när ett gränssnitt ändras och jämför den regelbundet med observerad trafik och schemalagda jobb. En statisk förteckning missar snabbt inofficiella anslutningar.

## Intervjufälla

En lista över endpoints beskriver inte ensam ett kontrakt. Ett starkt svar omfattar verksamhetsbetydelse, ägarskap och felbeteende och väljer en detaljnivå som går att underhålla.

Börja med verksamhetsflöden

Exempelpost

Håll katalogen tillförlitlig

Intervjufälla

Relaterade frågor