Потребители зависят от недокументированных payload
Никто не помнит, какие поля на самом деле критичны, пока изменение одного не ломает три интеграции сразу.
API-инжиниринг eCommerce
Для команд, предоставляющих каталог, цены, аккаунты, корзину или заказы storefront, приложениям, партнёрам и внутренним потребителям — с ownership, версионированием и поведением при отказах, определёнными заранее.
ПРИЗНАКИ ТОГО, ЧТО У API НЕТ НАСТОЯЩЕГО ВЛАДЕЛЬЦА
Никто не помнит, какие поля на самом деле критичны, пока изменение одного не ломает три интеграции сразу.
Каждый потребитель читает те же таблицы напрямую, поэтому ничего нельзя изменить, не проверив, кто туда смотрит.
Нет единого места, которое владеет процессом, поэтому никто не может сказать, что произойдёт, если шаг три провалится.
Каждый потребитель должен обновиться в тот же день, потому что нет версии, на которую можно откатиться.
НАШ ПОДХОД
REST, GraphQL, events и batch решают разные задачи доступа и consistency. Контракт должен назвать владельца возможности, потребителей и поведение при отказах ещё до выбора транспорта.
Bounded-запросы, которым нужен немедленный ответ и определённый timeout.
Errors, retries, rate limits и idempotency — часть контракта, а не что-то второстепенное.Публикация изменений состояния независимым потребителям без привязки к их релизным графикам.
Delivery semantics, порядок, replay и эволюция схемы должны быть явными.Одно бизнес-действие координирует несколько систем и требует компенсации или reconciliation.
Orchestrator владеет состоянием процесса — а не каждой source-записью за ним.ЧТО МЫ БЕРЁМ НА СЕБЯ
Commands, queries, resources, events, identifiers и ownership становятся явными, а authentication, authorization, scopes и secrets моделируются с самого начала.
Мы не выдумываем бизнес-политику без named owner; формальная сертификация оценивается отдельно.Deprecation, эволюция схемы и окна миграции планируются заранее, а timeouts, retries, idempotency и порядок становятся тестируемыми, а не предполагаемыми.
Потребители отвечают за завершение собственных согласованных миграций; доступность source-систем остаётся явной зависимостью.Traces, metrics, logs и alerts поддерживают диагностику с первого дня, а contract tests, sandbox и поэтапное внедрение позволяют каждому потребителю двигаться в своём темпе.
24/7 поддержка требует отдельного соглашения; каждая реализация потребителя оценивается отдельно.КАК МЫ РАБОТАЕМ
Процессы, ограничения, системы, репрезентативные данные и контекст стейкхолдеров.
Фиксируем решения, сценарии отказов, зависимости и пробелы в доказательствах.
Описание проблемы, карта рисков и вопросы build-vs-buy.
Согласованное описание проблемы и доступ к техническим владельцам.
Определяем границы, контракты, владение данными и тонкие вертикальные срезы.
Архитектурное решение, backlog и критерии приёмки.
Приоритетный срез, среды, тестовые данные и ответственные за проверку.
Реализуем возможность с автоматическими проверками, наблюдаемостью и контролируемой интеграцией.
Рабочий инкремент, код, тесты и операционная документация.
Данные production, инциденты, использование и бизнес-отклик.
Оцениваем результат, устраняем ограничения и определяем следующую возможность.
Выводы, обновлённый backlog и план передачи или поддержки.
ЧАСТЫЕ ВОПРОСЫ
Первый шаг сравнивает то, что уже покрывает поддерживаемая платформа, с тем, что действительно требует собственного контракта. API-граница должна пройти это сравнение, а не просто звучать современнее.
Да, после проверки существующих контрактов, потребителей, сценариев отказов и операционных рисков. Этот обзор определяет, что можно безопасно менять, до согласования объёма работ.
Вам. Проектные результаты передаются по условиям подписанного договора; сторонние и уже существующие компоненты отмечаются отдельно.
Мы рассмотрим ваши consumer journeys и ограничения, определим, чего не хватает, и предложим наименьший полезный следующий шаг — delivery-обязательства появляются только после согласования объёма и ответственности.
Покажите consumer journey и payload, от которых он зависит сегодня — мы скажем, какой минимальный контракт действительно нужен.
Обсудить API-границу →Нужна просто стандартная платформа, а не кастомный API? Смотрите выбор платформы и replatforming →