Проєктування API в AWS

Розроблення застосунків на AWS

Ricardo Sueiras

Principal Technologist

API Gateway

 

 

• Amazon API Gateway: керована служба для створення API.
• Проєктуйте, розгортайте, керуйте та захищайте свої API.

Можливості Amazon API Gateway

 

• Реалізуйте різні типи API.

Можливості Amazon API Gateway

 

• Реалізуйте різні типи API.
• Інтегруйтеся з бекенд‑службами.

Можливості Amazon API Gateway

 

• Реалізуйте різні типи API.
• Інтегруйтеся з бекенд‑службами.
• Захищайте доступ до API.

Можливості Amazon API Gateway

 

• Реалізуйте різні типи API.
• Інтегруйтеся з бекенд‑службами.
• Захищайте доступ до API.
• Обмежуйте запити, щоб захистити бекенди.

Можливості Amazon API Gateway

 

• Реалізуйте різні типи API.
• Інтегруйтеся з бекенд‑службами.
• Захищайте доступ до API.
• Обмежуйте запити, щоб захистити бекенди.
• Трансформуйте корисні навантаження запитів і відповідей.

Можливості Amazon API Gateway

 

• Реалізуйте різні типи API.
• Інтегруйтеся з бекенд‑службами.
• Захищайте доступ до API.
• Обмежуйте запити, щоб захистити бекенди.
• Трансформуйте корисні навантаження запитів і відповідей.
• Публікуйте API для споживачів.

Можливості Amazon API Gateway

 

• Реалізуйте різні типи API.
• Інтегруйтеся з бекенд‑службами.
• Захищайте доступ до API.
• Обмежуйте запити, щоб захистити бекенди.
• Трансформуйте корисні навантаження запитів і відповідей.
• Публікуйте API для споживачів.
• Керуйте життєвим циклом API: версії, розгортання, псевдоніми.

Типи API

• API Gateway підтримує три типи API:
  • REST API
  • HTTP API
  • WebSocket API

 

Кінцеві точки API Gateway

• Кінцеві точки керують тим, як клієнти звертаються до вашого API.
• Edge-optimized: CloudFront від AWS для глобальної низької затримки.
• Regional: розгортається в певному регіоні AWS.
• Private: доступ лише через AWS PrivateLink.
• Приватні кінцеві точки не виходять в публічний інтернет.

 

REST API

• Найповнішій за функціями варіант API Gateway.
• Побудовано на синхронній моделі запит/відповідь.

 

Випадки використання REST API

 

• Корпоративні API з повним керуванням життєвим циклом.
• API з розширеними засобами безпеки.
• Екосистеми сторонніх розробників з ключами API та планами використання.
• Прямі інтеграції зі службами AWS без Lambda.

Підтримка REST API в API Gateway

 

• Валідація запитів.
• Ключі API.
• Плани використання та обмеження швидкості.
• Кешування відповідей з налаштовуваним TTL.
• Трансформації запитів/відповідей через шаблони VTL.
• Аутентифікація IAM (Signature V4).
• Авторизатори Lambda, пули користувачів Cognito.

Підтримка REST API в API Gateway

 

 

• Підтримуються три типи кінцевих точок:
  • Edge-optimized
  • Regional
  • Private
• Захист від веб‑загроз за допомогою AWS WAF.
• Розгортання типу canary.
• Спостережуваність через AWS X-Ray і журналювання CloudWatch.

Компроміси REST API

• Дорожчі за HTTP API.
• Трохи вища затримка.

 

HTTP API

• Оптимізовані за продуктивністю та вартістю, а не за кількістю функцій:
  • Продуктивність
  • Вартість

 

Випадки використання HTTP API

• Безсерверні навантаження та API на базі Lambda.
• Мікросервіси та легкі проксі‑API.
• Додатки, чутливі до затримок.
• API з автентифікацією OAuth 2.0 / OIDC.

 

Підтримка HTTP API в API Gateway

 

• Інтеграції та авторизатори Lambda proxy.
• Рідна авторизація JWT/OIDC (Cognito, Auth0, Okta).
• Вбудована конфігурація CORS на рівні API.
• Приватні інтеграції VPC через VPC Link.
• Базове зіставлення параметрів для заголовків, рядків запиту та шляхів.

Компроміси HTTP API

 

• HTTP API НЕ підтримують:

  • ключі API
  • плани використання
  • валідацію запитів
  • кешування відповідей
  • трасування з AWS X-Ray

  • трансформацію корисного навантаження VTL

  • Підтримують лише:

    • Edge або приватні кінцеві точки (лише регіональні)

WebSocket API

 

• Двосторонній обмін між клієнтами та серверами.
• З'єднання залишається відкритим, на відміну від REST і HTTP API.
• Сервери можуть пушити дані підключеним клієнтам.

Випадки використання WebSocket API

• Чат‑додатки.
• Сповіщення в реальному часі.
• Дашборди в реальному часі.

 

Підтримка WebSocket API в API Gateway

• Трансформації даних у корисному навантаженні.
• Валідація запитів.
• Спеціальні вбудовані роуті:
  • $connect: клієнт встановлює з'єднання
  • $disconnect: клієнт від'єднується
  • $default: відповідного маршруту не знайдено

 

Кешування API

• Кешування відповідей зменшує навантаження на бекенд.
• Підвищує продуктивність API.
• Типові випадки:
  • Часто запитувані дані
  • API з переважно читанням
  • Зменшення викликів Lambda

 

Кешування API

 

• Кешовані відповіді протерміновуються після налаштованого TTL.
• Керуйте застарілими даними:
  • Налаштуйте час життя кешу
  • Скидайте кеш

Найкращі практики дизайну API: зрозумілі назви ресурсів

 

• Шляхи мають представляти ресурси, а не дії.
• Використовуйте іменники, а не дієслова.
• Добре:
  • GET /orders/123
• Уникайте:
  • GET /getOrder/123

Найкращі практики дизайну API: версонуйте API

 

• Версонуйте API, щоб безпечно їх розвивати.
• Не ламаючи існуючих клієнтів.
• Поширені підходи:
  • Версія в URI: GET /v1/orders
  • Параметр запиту: GET /orders?version=1
  • Заголовок HTTP: Accept-Version: v1

Портали для розробників API

• Публікуйте й поширюйте REST API через веб‑портал.
• Надавайте документацію споживачам API.
• Ключові можливості:
  • Документація API (файли Swagger)
  • Онбординг споживачів
  • Завантаження SDK
  • Реєстрація ключів API та підписка

 

Специфікації OpenAPI

• OpenAPI (Swagger): стандарт опису REST API.
• API Gateway може імпортувати й експортувати специфікації OpenAPI.

 

Давайте потренуємось!

Розроблення застосунків на AWS