Как составить каталог межсистемных интерфейсов?

Question

IT Interview Practice · Accepted Answer

Создайте **каталог интерфейсов** как поддерживаемый перечень межсистемных контрактов и их владельцев. Он связывает архитектурную схему с подробностями, необходимыми для реализации, реагирования на инциденты и планирования изменений.

## Начните с бизнес-процессов

Пройдите реальный процесс, например исполнение заказа, и перечислите каждый API-вызов, событие, передачу файла и плановый обмен данными. Включите менее заметные пути, например выгрузки для сверки и ручные импорты для восстановления.

Для каждого интерфейса зафиксируйте:

- Стабильный идентификатор, бизнес-назначение, производителя, потребителей и ответственные контакты.
- Направление, транспорт, endpoint или расположение файла и ссылку на версионируемую схему.
- Ответственность за данные, идентификаторы, классификацию и механизм доступа без хранения секретов авторизации.
- Сроки или расписание, ожидаемый объём, ограничения размера и согласованные ожидания от сервиса.
- Правила тайм-аутов, повторов, дублей, порядка и обработки ошибок, где это применимо.
- Мониторинг, эскалацию, политику совместимости и зависимости при выводе из эксплуатации.

## Пример записи

Интерфейс IF-07 отправляет подтверждения отгрузки со склада в платформу заказов каждые 15 минут. Склад отвечает за поток, а платформа заказов — за приём. Контракт задаёт идентификатор отгрузки, версию схемы, число записей и файл подтверждения. Отсутствие подтверждений эскалируется определённой команде поддержки.

Это полезнее стрелки с надписью «интеграция»: команда может выяснить, вызвана ли задержка обновления отгрузки транспортным сбоем, отклонением данных или пропуском планового запуска.

## Поддерживайте достоверность каталога

Ссылайтесь на схемы и эксплуатационные инструкции вместо копирования содержимого. Обновляйте каталог при изменении интерфейса и периодически сравнивайте его с наблюдаемым трафиком и заданиями по расписанию. Статический перечень быстро перестаёт учитывать неофициальные связи.

## Ловушка на собеседовании

Один список endpoint’ов не описывает контракт. Сильный ответ включает бизнес-смысл, владельцев и поведение при сбоях, сохраняя сопровождаемый уровень детализации.

Начните с бизнес-процессов

Пример записи

Поддерживайте достоверность каталога

Ловушка на собеседовании

Похожие вопросы