Вопросы и ответы по Amazon API Gateway

Amazon API Gateway – это полностью управляемый сервис для разработчиков, который упрощает публикацию, обслуживание, мониторинг и обеспечение безопасности API в любых масштабах. Выполнив несколько простых действий в Консоли управления AWS, можно создать API, предоставляющий доступ к данным, бизнес-логике или возможностям серверных сервисов для приложений, работающих на Amazon Elastic Compute Cloud (Amazon EC2), Amazon Elastic Container Service (Amazon ECS), AWS Elastic Beanstalk, для кода, выполняемого на AWS Lambda, а также любых интернет-приложений. Amazon API Gateway выполняет любые задания, связанные с приемом и обработкой сотен тысяч одновременных вызовов API, включая управление трафиком, авторизацию и контроль доступа, мониторинг и управление версиями API. Работа с Amazon API Gateway не требует минимальных платежей или стартовых вложений. Что касается API HTTP и API REST, оплате подлежат только полученные вызовы API и фактический объем исходящего трафика. Что касается API WebSocket, вы платите только за полученные и отправленные сообщения, а также за то время, в течение которого пользователь или устройство были подключены к API WebSocket.

Amazon API Gateway – это простой, гибкий, полностью управляемый сервис для разработчиков с оплатой по факту использования. Он берет на себя все трудоемкие операции по созданию и обслуживанию разнообразных API для серверной части приложений. API Gateway обеспечивает быстрый и экономичный запуск новых сервисов, тем самым позволяя вам уделить максимум внимания созданию ключевых бизнес-сервисов. API Gateway создан для упрощения работы по созданию и управлению API с учетом ряда аспектов.

1. Измерение показателей. API Gateway помогает сформировать планы по измерению показателей работы API и ограничению доступа к ним для сторонних разработчиков. Можно определить набор планов, настроить ограничения и предельные квоты для каждого ключа API. API Gateway автоматически измеряет трафик к вашим API и позволяет извлечь данные по использованию каждого ключа API.

2. Безопасность. API Gateway предоставляет множество инструментов для авторизации доступа к API и управления доступом к сервисным операциям. Для авторизации доступа к API сервис API Gateway позволяет использовать инструменты AWS для администрирования и обеспечения безопасности, например AWS Identity and Access Management (IAM) или Amazon Cognito. API Gateway может от вашего имени верифицировать подписанные вызовы API с помощью той же последовательности действий, которая используется для API сервисов AWS. Сервис API Gateway применяет специальные средства авторизации, написанные в виде функций AWS Lambda, и помогает верифицировать входящие токены на предъявителя. Это позволяет не заботиться об авторизации при разработке серверного кода.

3. Стабильная работа. API Gateway позволяет регулировать трафик с использованием ограничений, чтобы серверные процессы продолжали стабильно работать в пиковых ситуациях. Кроме того, API Gateway помогает повысить производительность API и сократить задержку для конечных пользователей путем кэширования ответов на вызовы API, что позволяет избежать постоянных обращений к серверным системам.

4. Мониторинг процессов. После публикации API и начала его использования Amazon API Gateway предоставляет панель управления метриками для отслеживания вызовов к сервисам. Благодаря интеграции с сервисом Amazon CloudWatch панель управления API Gateway позволяет отображать метрики производительности веб-сервисов, которые включают данные о вызовах API, задержке передачи данных и коэффициенте ошибок. Можно включить подробное отображение метрик для каждого из методов в API и фиксировать данные об ошибках, доступе и отладке в журналах CloudWatch Logs.

5. Управление жизненным циклом. После публикации API часто возникает необходимость в создании и тестировании его новых версий, которые расширяют или дополняют функциональные возможности API. Сервис API Gateway позволяет одновременно работать с несколькими версиями API и несколькими стадиями каждой версии, поэтому приложения могут вызывать предшествующие версии API и после публикации новых.

6. Сервис, созданный для разработчиков. API Gateway позволяет быстро создавать API и определять статический контент для их ответов, чтобы упростить разработчикам различного профиля процесс создания приложений и ускорить их выход на рынок. Команды разработчиков, работа которых зависит от ваших API, могут начать разработку, пока вы создаете серверные процессы.

7. Двустороннее взаимодействие в режиме реального времени. Создавайте приложения для двустороннего взаимодействия в режиме реального времени, например приложения чатов, панелей управления с потоковой передачей и уведомлений, не прибегая к подготовке серверов или управлению ими. API Gateway поддерживает постоянное соединение между подключенными пользователями и обеспечивает возможность передачи сообщений между ними.

Amazon API Gateway предлагает два варианта создания интерфейсов API RESTful – API HTTP и API REST, а также один вариант создания API WebSocket.

API HTTP. Интерфейсы API HTTP оптимизированы для создания API, которые передают функции AWS Lambda или серверные части HTTP, что делает их идеальными для обработки бессерверных рабочих нагрузок. В настоящее время они не предоставляют функции управления API.

Обработка запросов на основе передачи состояния. Интерфейсы Обработки запросов на основе передачи состояния предлагают функции прокси‑сервера для API и возможности управления в составе одного решения. API REST предоставляют функции управления API, такие как планы использования, ключи API, публикации и API для монетизации.

API веб-сокетов. Интерфейсы API веб-сокетов поддерживают постоянное соединение между подключенными клиентами, обеспечивая возможность обмена сообщениями в режиме реального времени. С помощью API WebSocket в API Gateway можно определить серверные интеграции с функциями AWS Lambda, Amazon Kinesis или любым адресом HTTP, которые будут вызываться при получении сообщений от подключенных клиентов.

Чтобы начать работу с интерфейсами API HTTP, можно использовать консоль Amazon API Gateway, интерфейс командной строки AWS, AWS SDK или AWS CloudFormation. Подробнее о начале работы с API HTTP см. в документации.

Чтобы начать работу с интерфейсами API REST, можно использовать консоль Amazon API Gateway, интерфейс командной строки AWS или AWS SDK. Подробнее о начале работы с API REST см. в документации.

Создать API RESTful можно как с помощью API HTTP, так и с помощью API REST в Amazon API Gateway.

Интерфейсы API HTTP оптимизированы для создания API, которые передают функции AWS Lambda или серверные части HTTP, что делает их идеальными для обработки бессерверных рабочих нагрузок. Интерфейсы API HTTP являются более дешевой и быстрой альтернативой API REST, однако в настоящее время они не поддерживают функциональные возможности управления API. API REST предназначены для API, которым требуются функции прокси‑сервера для API и возможности управления в составе одного решения.

API HTTP идеально подходят для следующих случаев.

1. Создание прокси‑интерфейсов API для AWS Lambda или любого адреса HTTP.
2. Создание современных API с авторизацией OAuth 2 и OIDC. 
3. Рабочие нагрузки, которые могут очень сильно вырасти.
4. API для чувствительных к задержкам рабочих нагрузок.

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

Стандартный пакет интерфейсов API HTTP включает поддержку CORS, OIDC и OAuth2 для аутентификации и авторизации, а также автоматическое развертывание на этапах.

Да, вы можете импортировать определение API с помощью OpenAPI 3. Это приведет к созданию маршрутов, интеграций и моделей API. Подробнее об импорте определений OpenAPI см. в документации.

Для перехода от текущего интерфейса API REST к API HTTP в Amazon API Gateway выполните следующие действия.

1. Убедитесь, что все необходимые вам функции доступны в HTTP. Полный список функций см. в документации. 
2. Перейдите к API REST и экспортируйте из него определение OpenAPI.
3. Перейдите к API HTTP и импортируйте определение OpenAPI из предыдущего действия.
4. Проверьте работу функций API.
5. Обновите клиенты, указав новый URL.

Несмотря на нормальную работу API вы можете заметить, что некоторые функции отсутствуют. Для определения недостающих функций просмотрите поля Info (Информация), Warning (Предупреждение) и Error (Ошибка) в операции импорта. Подробнее о переходе с API REST на API HTTP см. в документации.

Во‑первых, перейдите к вашему API REST и экспортируйте из него определение OpenAPI. Затем перейдите к API HTTP и импортируйте определение OpenAPI из предыдущего действия. Несмотря на нормальную работу API вы можете заметить, что некоторые функции отсутствуют. Для определения недостающих функций просмотрите поля Info (Информация), Warning (Предупреждение) и Error (Ошибка) в операции импорта. Интерфейс командной строки AWS вернет информацию о вашем API в полях Info (Информация) и Warning (Предупреждение). Дополнительную информацию см. в документации.

Сначала нужно создать WebSocket API с помощью AWS Management Console, AWS CLI или SDK AWS. После этого можно задать маршрутизацию WebSocket, указав такие серверные сервисы, как AWS Lambda, Amazon Kinesis или ваш адрес HTTP, которые будут вызываться в соответствии с содержимым сообщений. См. документацию по началу работы с API WebSocket в API Gateway.

Да, все API, созданные с помощью сервиса Amazon API Gateway, поддерживают только конечные точки HTTPS. Amazon API Gateway не поддерживает конечные точки без шифрования (HTTP). По умолчанию Amazon API Gateway назначает для API внутренний домен, который автоматически использует сертификат сервиса Amazon API Gateway. Настраивая API для работы под другим доменным именем, вы можете предоставить для домена собственный сертификат.

API, созданные с помощью Amazon API Gateway, могут принимать любые полезные данные, переданные по HTTPS для API HTTP, API REST и API WebSocket. Как правило, используются форматы параметров строки запроса, заголовков запроса, JSON или XML. Вы можете назначить в качестве ответов на вызовы API контент любого типа, а затем с помощью шаблонов трансформации преобразовывать ответы сервера в нужный формат.

Amazon API Gateway может выполнять функции AWS Lambda в вашем аккаунте, запускать машины состояний AWS Step Functions или вызывать конечные точки HTTP, размещенные в AWS Elastic Beanstalk, Amazon EC2, а также операции HTTP (размещенные на отличных от AWS платформах), доступные через публичный Интернет. API Gateway также позволяет указать шаблон привязки для создания возвращаемого статического содержимого. Благодаря этому вы сможете имитировать API-интерфейсы еще до того, как серверные компоненты будут готовы. API Gateway можно также напрямую интегрировать с другими сервисами AWS. Например, можно открыть в сервисе API Gateway метод API, который будет отправлять данные напрямую в Amazon Kinesis.

API Gateway генерирует специальные пакеты SDK для разработки мобильных приложений на базе Android и iOS (Swift и Objective-C) и для разработки интернет-приложений на JavaScript. Кроме того, API Gateway поддерживает генерацию SDK для Ruby и Java. Определив API и его модели в API Gateway, с помощью Консоли AWS или API сервиса API Gateway можно сгенерировать и загрузить клиентский пакет SDK. Клиентские SDK генерируются только для API REST в Amazon API Gateway.

Просмотреть доступность API HTTP, Обработки запросов на основе передачи состояния, API веб-сокетов можно в таблице Регионов AWS здесь.

В консоли Amazon API Gateway можно определять API REST и связанные с ним ресурсы и методы, управлять жизненным циклом API, генерировать клиентские SDK и просматривать метрики API. Для определения планов использования ваших API, управления ключами API разработчиков и установки предельных квот и ограничений можно также использовать консоль API Gateway. Все эти действия можно также выполнять с помощью API сервиса Amazon API Gateway.

Ресурс – это типизированный объект, относящийся к домену вашего API. Каждый ресурс может быть связан с некой моделью данных, с другими ресурсами, а также может отвечать на различные методы. Дополнительно можно определить ресурсы как переменные для перехвата запросов к нескольким связанным ресурсам.

Каждый ресурс отдельно взятого API REST может поддерживать один или несколько стандартных методов HTTP. Разработчик определяет команды, которые должны поддерживаться ресурсом (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS), и их реализацию. Например, команда GET ресурса cars должна возвращать список автомобилей. Чтобы подключить все методы внутри ресурса к единому адресу сервера, API Gateway также поддерживает специальный метод «ANY».

Планы использования назначаются для сторонних разработчиков для ограничения доступа к определенным API, определения ограничений и предельных квот запросов и связывания их с ключами API. Для анализа использования API и создания платежных документов можно извлечь данные использования по конкретным ключам API. Например, можно создать базовый, профессиональный и корпоративный планы. Для базового плана использования можно разрешить, к примеру, 1000 запросов в день и не более 5 запросов в секунду (RPS).

Каждый API REST сервиса Amazon API Gateway может содержать множество стадий. Наличие стадий упрощает жизненный цикл разработки API. Например, после создания API можно выполнить их развертывание до стадии разработки, а после подготовки их к использованию в рабочей среде – развертывание до рабочей стадии.

Стадии сервиса Amazon API Gateway аналогичны тегам. Они определяют готовность к развертыванию до того или иного этапа. Например, вы можете определить стадию разработки и выполнить развертывание API cars до этой стадии. В этом случае ресурс будет доступен по адресу https://www.myapi.com/dev/cars. Можно также задать пользовательские доменные имена, которые будут указывать непосредственно на стадию, что позволит избежать использования дополнительного параметра пути. Например, если адрес myapi.com будет указывать непосредственно на стадию разработки, ваш ресурс cars будет доступен по адресу https://www.myapi.com/cars. Стадии можно настроить с помощью переменных, которые доступны в шаблонах настройки или привязки API.

Переменные стадии позволяют задавать пары «ключ-значение» для значений конфигурации, связанных с той или иной стадией. Эти значения, аналогично переменным окружения, можно использовать для настройки API. Например, можно задать конечную точку HTTP в качестве переменной стадии для интеграции метода и использовать эту переменную в конфигурации API вместо жестко заданной конечной точки. Это позволяет использовать разные конечные точки для каждой стадии (например для разработки, бета-тестирования и рабочей версии) в одной и той же конфигурации API. Переменные стадии также доступны в шаблонах привязки и могут быть использованы для передачи параметров конфигурации серверу Lambda или HTTP.

Да. Можно использовать наш инструмент импорта с открытым исходным кодом Swagger importer для импорта ваших определений API Swagger в сервис Amazon API Gateway. С помощью инструмента импорта Swagger importer можно создавать и развертывать новые API, а также обновлять существующие.

Вы можете монетизировать свои API в API Gateway, разместив их в качестве продуктов на AWS Marketplace. Для этого сначала необходимо зарегистрироваться в качестве продавца на AWS Marketplace, а затем предоставить свои планы использования API как продуктов для сервиса API Gateway. Здесь можно узнать подробнее о монетизации API.

Помимо обеспечения поддержки документирования API в соответствии со стандартами, сервис API Gateway поддерживает наследование документации. Это дает возможность один раз определить строку документации и затем использовать это определение в нескольких местах. Механизм наследования упрощает процесс определения документации API и позволяет сконвертировать ее в стандартное представление при экспорте API в виде файла Swagger.

Да, можно применить к API политику ресурса, чтобы разрешить доступ только для определенного облака Amazon VPC или адреса VPC. Кроме того, с помощью политики ресурса можно предоставить доступ к частному API для облака Amazon VPC или адреса VPC из другого аккаунта.