API gateway, или шлюз API, — это единая точка входа для обращений к вашим программным интерфейсам. Запрос сначала попадает в шлюз: тот проверяет, кто обращается и что ему разрешено, считает число запросов, выбирает, какому сервису их передать, и записывает обращение в журнал. Бизнес-правил шлюз не знает: он работает как проходная, а не как цех.
Нужен он, когда за одним адресом стоит несколько сервисов, обращаются разные потребители с разными правами и лимитами, а доступ одного партнёра надо отозвать, не остановив остальных. Для одного сервиса и одного потребителя хватит обычного веб-сервера с шифрованием и ограничением частоты. От интеграционной шины шлюз отличается тем, что работает с запросами и ответами, а не с потоком сообщений между системами; сравнение в таблице ниже. Если тема новая, начните со статьи «API простыми словами».
Что происходит с запросом на шлюзе
Условный пример. За одним адресом работают три сервиса: каталог, заказы и документы. К ним обращаются кабинет партнёров, система партнёра и ваши внутренние системы. Каждый запрос проходит одни и те же шаги.
| Шаг | Что делает шлюз | Зачем |
|---|---|---|
| Приём | Принимает соединение и завершает защищённый канал (TLS) | Шифрование настроено в одном месте, а не в каждом сервисе |
| Опознание | Проверяет ключ или токен: подлинность и срок действия | Сервисы получают уже опознанного потребителя |
| Права по маршруту | Сверяет, разрешены ли этому потребителю адрес и метод | Партнёру открыты только нужные операции |
| Лимиты | Считает запросы по ключу, при превышении отвечает отказом и указывает, когда повторить | Один потребитель не занимает ресурсы всех |
| Проверка запроса | Смотрит размер, формат и обязательные заголовки, отсекает заведомо неверное | Мусор не доходит до сервисов |
| Маршрутизация | Выбирает сервис и его версию, распределяет по экземплярам, ставит тайм-аут | Адрес для клиента один, а сервисы за ним можно менять |
| Журнал | Записывает, кто, что и когда запрашивал, добавляет сквозной номер запроса | По номеру находят путь запроса через все сервисы |
Шлюз может работать и с ответом: складывать в кэш то, что меняется редко, убирать служебные заголовки. Но главное в нём — повторяемые, не зависящие от бизнеса проверки, собранные в одном месте.
Шлюз и шина: в чём разница
Эти два слоя легко спутать: оба стоят «посередине» и оба маршрутизируют. Различие в том, с чем они работают.
| Критерий | Шлюз API | Интеграционная шина |
|---|---|---|
| Кто обращается | Клиенты и партнёры снаружи, приложения, сервисы друг к другу | Системы предприятия между собой |
| Характер обмена | Запрос и немедленный ответ | Сообщения, которые доставляются позже и с повторами; синхронные вызовы тоже возможны |
| Что видит | Адрес, метод, ключ, заголовки; тело запроса почти не трогает | Содержимое сообщений: форматы, справочники, маршруты по содержанию |
| Хранит ли сообщения | Нет: если сервис недоступен, запрос получает отказ | Да: очередь с повторами и список недоставленного |
| Преобразование данных | Заголовки, адреса, иногда простые поля | Главная задача: перевод между форматами систем |
| Главный вопрос | Кто вы и сколько вам можно | Кому передать и не потеряется ли |
| Если остановился | Недоступны все API за шлюзом | Данные копятся у отправителей, если те сохраняют исходящее у себя |
Продукты пересекаются: шлюзы умеют преобразовывать, а шины — публиковать интерфейсы. Граница проходит по назначению, а не по названию. В одной архитектуре обычно нужны оба слоя: шлюз как вход в сервисы и шина как обмен между системами. Устройство шины описано в статье «Интеграционная шина: что это».
Что шлюз закрывает в безопасности, а что нет
Шлюз — первый рубеж, но не вся защита. Таблица показывает, какие угрозы он снимает сам, а какие остаются на сервисах.
| Угроза | Закрывает ли шлюз | Что нужно ещё |
|---|---|---|
| Перебор ключей и учётных данных | Частично: лимиты по ключу и адресу, блокировка | Ограничение попыток на входе, ключи достаточной длины, оповещение о всплеске отказов |
| Утечка ключа партнёра | Да, если ключи выдаются и отзываются централизованно | Отдельный ключ на каждого потребителя, срок действия, порядок перевыпуска |
| Доступ к чужому объекту подменой идентификатора | Нет: шлюз не знает, чей это заказ | Проверка права на объект внутри сервиса |
| Лишние поля в ответе | Нет | Явный состав ответа в сервисе, а не вывод записи целиком |
| Слишком большие и неверные запросы | Частично: размер и формат по схеме | Проверка входных данных в самом сервисе |
| Вызовы между сервисами внутри контура | Нет: шлюз стоит на входе | Проверка вызывающего и права на уровне сервисов |
| Распределённая атака на доступность | Нет | Защита от DDoS у оператора связи или хостера; мы ею не занимаемся |
Ошибки авторизации на уровне объекта стоят в списке OWASP API Security среди самых серьёзных, и закрываются они только в сервисе. Порядок мер разобран в статье «Как защитить API от взлома» и на странице «Защита API от несанкционированного доступа».
Когда шлюз нужен, а когда хватит обычного веб-сервера
Шлюз оправдан, когда
- за одним адресом работает несколько сервисов, а снаружи это должно выглядеть как один интерфейс;
- потребителей много, у каждого свои права и лимиты, а ключи нужно выдавать и отзывать без релиза;
- нужны единый журнал обращений и сквозной номер запроса;
- версии интерфейса сосуществуют, и потребителей переводят на новую по очереди;
- проверки входа и лимитов повторяются в каждом сервисе, и их надо свести в одно место.
Хватит веб-сервера, когда
- сервис один, потребителей один-два, и все известны;
- шифрование и ограничение частоты решаются настройкой обычного веб-сервера;
- некому сопровождать ещё один компонент и разбирать его отказы.
Единая точка отказа и как её снижают
Шлюз стоит перед всеми сервисами, и его остановка выключает их все. Это не причина отказываться от шлюза, а список того, что нужно сделать.
- Без состояния и в двух экземплярах. Шлюз не должен хранить то, что нельзя потерять. Тогда его можно держать минимум в двух экземплярах за балансировщиком и перезапускать по очереди.
- Конфигурация в репозитории. Маршруты, лимиты и права меняются через проверяемое изменение и откатываются, а не правятся руками на боевом сервере.
- Тайм-ауты и ограничение повторов. Медленный сервис не должен занять все соединения шлюза: у каждого маршрута свой тайм-аут, число повторов ограничено.
- Проверка состояния и плавное обновление. Шлюз перестаёт слать запросы на неисправный экземпляр сервиса, а обновляется по одному экземпляру без остановки приёма.
- Счётчики лимитов. Точный общий лимит на все экземпляры требует общего хранилища счётчиков, и оно становится ещё одной зависимостью. Лимит на каждый экземпляр отдельно проще, но допускает перекос. Выбор записывается в обследовании.
- План для потребителей. Что делает партнёр, получив отказ или тишину: повторяет с растущей паузой, а не заваливает шлюз запросами сразу после запуска.
Что не стоит класть в шлюз
Шлюз знает «кто, куда и сколько»; «что» и «почему» знают сервисы. Из этого следует список того, чему в шлюзе не место.
- Бизнес-правила и расчёты. Цена, скидка, проверка лимита живут в сервисах, иначе правила появятся в двух местах.
- Сложные преобразования данных. Перевод между форматами систем — задача шины или самого сервиса.
- Сборка ответа из нескольких сервисов с логикой. Если интерфейсу телефона нужен один ответ из трёх сервисов, это отдельный слой под этого клиента, а не расширение шлюза.
- Долгие операции. Выгрузка за год или пересчёт запускаются как отдельная задача: клиенту возвращается номер, по которому он позже забирает результат.
- Исправление плохого API. Шлюз не сделает единообразными ошибки, версии и имена, если сервисы возвращают их как придётся: это правится в сервисах.
Как проверить шлюз до приёмки
Шесть проверок, которые можно выполнить на стенде. Если любая не проходит, шлюз принимать рано.
- Выдайте два ключа и отзовите один: второй продолжает работать, а первый получает отказ; заранее известно, через какое время после отзыва это происходит.
- Превысьте лимит: ответ понятный, с указанием, когда повторить, а в журнале есть запись о превышении.
- Отключите один из сервисов: шлюз отвечает ошибкой за ограниченное время и не зависает, остальные маршруты работают.
- Подставьте чужой идентификатор объекта с действующим ключом: отказывает сам сервис, потому что проверка права на объект не должна опираться на шлюз.
- Остановите один экземпляр шлюза: запросы идут через второй, потребители ошибок не видят или видят единичные.
- Найдите запрос по сквозному номеру: он есть и в журнале шлюза, и в журнале сервиса.
Эти проверки не заменяют нагрузочные испытания: пределы нагрузки зависят от вашего профиля и измеряются отдельно, при выводе в эксплуатацию.
Что делаем мы и с чего начать
Шлюз мы считаем частью разработки API и бэкенда, а не отдельным продуктом: берём готовый открытый компонент или возможности веб-сервера, настраиваем маршруты, ключи, лимиты и журнал, проверяем по списку выше и передаём конфигурацию в ваш репозиторий. Своё ядро шлюза с нуля не пишем. Если сервисов и потребителей немного, скажем, что шлюз не нужен. Услуга описана на странице «Разработка API и бэкенда», обмен между системами — на странице «Разработка интеграционной платформы».
Обследование стоит 200 000 ₽ и занимает 2–3 недели за один-два процесса, 350 000 ₽ и 3–4 недели, если систем несколько. На выходе список потребителей и операций, схема входа и прав, требования к надёжности и вилка бюджета. Сумма вычитается из первого этапа, если вы продолжаете с нами. Один API с шлюзом проверяет лёгкий пилот за 150 000–400 000 ₽ и 2–8 недель. Вывод в эксплуатацию идёт от 1 500 000 ₽ этапами по 300 000–700 000 ₽, сопровождение от 20 000 ₽ в месяц. Все цены и сроки — на странице «Тарифы». Защиту от DDoS, WAF и SIEM как услугу мы не оказываем, круглосуточного дежурства нет.
Частые вопросы
Чем API gateway отличается от обычного прокси?
Прокси передаёт запрос дальше и шифрует соединение. Шлюз добавляет то, что относится к программному интерфейсу: ключи и токены, права по методам, лимиты, версии и журнал по потребителям. Граница размыта: многие веб-серверы умеют часть этого настройкой.
Шлюз и шина: что нужно мне?
Если нужен вход для клиентов и партнёров в ваши сервисы, это шлюз. Если системы предприятия обмениваются данными между собой, особенно асинхронно и с преобразованием, это шина или платформа обмена. Часто нужны оба слоя, у каждого своя задача.
Заменяет ли шлюз проверку прав в самом сервисе?
Нет. Шлюз проверяет, кто обратился и что разрешено по адресу и методу, но не знает, чей это заказ. Проверка права на конкретный объект остаётся в сервисе, иначе подмена идентификатора в запросе откроет чужие данные.
Шлюз — это единая точка отказа?
Да, пока он один. Поэтому его ставят минимум в двух экземплярах, держат конфигурацию в репозитории, задают тайм-ауты и проверяют остановку одного экземпляра до запуска. Процент доступности мы не обещаем.
Нужен ли шлюз, если сервис один?
Обычно нет: хватит веб-сервера с шифрованием и ограничением частоты. Шлюз оправдан при нескольких сервисах, разных потребителях и необходимости отзывать ключи без релиза.
Защищает ли шлюз от DDoS?
Не стоит на это рассчитывать. Лимиты по ключу сдерживают одного неаккуратного потребителя, но не распределённую атаку из многих источников. Защита от DDoS — услуга оператора связи или хостера, мы ею не занимаемся.
Покупать готовый шлюз или писать свой?
Писать с нуля обычно не стоит: берут готовый компонент с открытым исходным кодом или возможности веб-сервера, а свой код нужен для особых правил. В закрытом контуре шлюз работает на вашем оборудовании без облачных сервисов.
Сколько стоит внедрить шлюз API?
Отдельной цены нет: шлюз входит в разработку API. Обследование — 200 000 ₽ за один-два процесса и 350 000 ₽ за несколько систем; лёгкий пилот одного API с шлюзом — 150 000–400 000 ₽ за 2–8 недель. Вывод в эксплуатацию от 1 500 000 ₽ этапами по 300 000–700 000 ₽.