Projektowanie API na AWS

Tworzenie aplikacji na AWS

Ricardo Sueiras

Principal Technologist

API Gateway

 

 

• Amazon API Gateway: zarządzana usługa do budowania API.
• Projektuj, wdrażaj, zarządzaj i zabezpieczaj swoje API.

Możliwości Amazon API Gateway

 

• Obsługa różnych typów API.

Możliwości Amazon API Gateway

 

• Obsługa różnych typów API.
• Integracja z usługami backendowymi.

Możliwości Amazon API Gateway

 

• Obsługa różnych typów API.
• Integracja z usługami backendowymi.
• Zabezpieczanie dostępu do API.

Możliwości Amazon API Gateway

 

• Obsługa różnych typów API.
• Integracja z usługami backendowymi.
• Zabezpieczanie dostępu do API.
• Ograniczanie liczby żądań w celu ochrony backendu.

Możliwości Amazon API Gateway

 

• Obsługa różnych typów API.
• Integracja z usługami backendowymi.
• Zabezpieczanie dostępu do API.
• Ograniczanie liczby żądań w celu ochrony backendu.
• Przekształcanie ładunków żądań i odpowiedzi.

Możliwości Amazon API Gateway

 

• Obsługa różnych typów API.
• Integracja z usługami backendowymi.
• Zabezpieczanie dostępu do API.
• Ograniczanie liczby żądań w celu ochrony backendu.
• Przekształcanie ładunków żądań i odpowiedzi.
• Publikowanie API dla odbiorców.

Możliwości Amazon API Gateway

 

• Obsługa różnych typów API.
• Integracja z usługami backendowymi.
• Zabezpieczanie dostępu do API.
• Ograniczanie liczby żądań w celu ochrony backendu.
• Przekształcanie ładunków żądań i odpowiedzi.
• Publikowanie API dla odbiorców.
• Zarządzanie cyklem życia API: wersjonowanie, wdrożenia, aliasy.

Typy API

• API Gateway obsługuje trzy typy API:
  • REST API
  • HTTP API
  • WebSocket API

 

Punkty końcowe API Gateway

• Punkty końcowe określają, jak klienci łączą się z API.
• Edge-optimized: CloudFront zarządzany przez AWS — niskie opóźnienia globalnie.
• Regional: wdrożony w konkretnym regionie AWS.
• Private: dostępny wyłącznie przez AWS PrivateLink.
• Prywatne punkty końcowe działają poza publicznym internetem.

 

REST API

• Najbogatsze w funkcje rozwiązanie API Gateway.
• Opiera się na synchronicznym modelu żądanie/odpowiedź.

 

Zastosowania REST API

 

• Korporacyjne API wymagające pełnego zarządzania cyklem życia.
• API z zaawansowanymi mechanizmami zabezpieczeń.
• Ekosystemy dla zewnętrznych deweloperów z kluczami API i planami użycia.
• Bezpośrednia integracja z usługami AWS bez Lambda.

Wsparcie REST API w API Gateway

 

• Walidacja żądań.
• Klucze API.
• Plany użycia i ograniczanie liczby żądań.
• Buforowanie odpowiedzi z konfigurowalnym TTL.
• Transformacja żądań i odpowiedzi za pomocą szablonów VTL.
• Uwierzytelnianie IAM (Signature V4).
• Autoryzatory Lambda, pule użytkowników Cognito.

Wsparcie REST API w API Gateway

 

 

• Trzy obsługiwane typy punktów końcowych:
  • Edge-optimized
  • Regional
  • Private
• Ochrona przed exploitami webowymi za pomocą AWS WAF.
• Wdrożenia kanarkowe (canary release).
• Obserwowalność przez AWS X-Ray i logowanie w CloudWatch.

Kompromisy REST API

• Wyższy koszt niż HTTP API.
• Nieco większe opóźnienia.

 

HTTP API

• Zoptymalizowane pod kątem wydajności i kosztów, kosztem zakresu funkcji:
  • Wydajność
  • Koszt

 

Zastosowania HTTP API

• Obciążenia bezserwerowe i API obsługiwane przez Lambda.
• Mikroserwisy i lekkie proxy API.
• Aplikacje wrażliwe na opóźnienia.
• API korzystające z uwierzytelniania OAuth 2.0 / OIDC.

 

Wsparcie HTTP API w API Gateway

 

• Integracje proxy Lambda i autoryzatory.
• Natywna autoryzacja JWT/OIDC (Cognito, Auth0, Okta).
• Wbudowana konfiguracja CORS na poziomie API.
• Prywatne integracje VPC przez VPC Link.
• Podstawowe mapowanie parametrów nagłówków, ciągów zapytań i ścieżek.

Kompromisy HTTP API

 

• HTTP API NIE obsługują:

  • Kluczy API
  • Planów użycia
  • Walidacji żądań
  • Buforowania odpowiedzi
  • Śledzenia z AWS X-Ray

  • Transformacji ładunków VTL

  • Obsługują tylko:

    • Punkty końcowe edge lub prywatne (tylko regionalne)

WebSocket API

 

• Dwukierunkowa komunikacja między klientami a serwerami.
• Połączenie pozostaje otwarte — inaczej niż w REST i HTTP API.
• Serwery mogą przesyłać dane do połączonych klientów.

Zastosowania WebSocket API

• Aplikacje czatu.
• Powiadomienia w czasie rzeczywistym.
• Pulpity nawigacyjne w czasie rzeczywistym.

 

Wsparcie WebSocket API w API Gateway

• Transformacje danych ładunków.
• Walidacja żądań.
• Specjalne wbudowane trasy:
  • $connect: klient nawiązuje połączenie
  • $disconnect: klient rozłącza się
  • $default: brak pasującej trasy

 

Buforowanie API

• Buforowanie odpowiedzi zmniejsza obciążenie backendu.
• Poprawia wydajność API.
• Typowe zastosowania:
  • Często żądane dane
  • API z dużą liczbą odczytów
  • Ograniczanie liczby wywołań Lambda

 

Buforowanie API

 

• Buforowane odpowiedzi wygasają po konfigurowalnym czasie TTL.
• Zarządzanie nieaktualnymi danymi przez:
  • Ustawienie czasu wygaśnięcia bufora
  • Wyczyszczenie bufora

Dobre praktyki projektowania API: czytelne nazwy zasobów

 

• Ścieżki powinny reprezentować zasoby, nie akcje.
• Używaj rzeczowników, nie czasowników.
• Dobrze:
  • GET /orders/123
• Unikaj:
  • GET /getOrder/123

Dobre praktyki projektowania API: wersjonowanie

 

• Wersjonuj API, by bezpiecznie je rozwijać w czasie.
• Unikaj łamania istniejących klientów.
• Popularne podejścia:
  • Wersjonowanie w URI: GET /v1/orders
  • Parametr zapytania: GET /orders?version=1
  • Nagłówek HTTP: Accept-Version: v1

Portale dla deweloperów API

• Publikuj i udostępniaj REST API przez portal webowy.
• Dostarczaj dokumentację odbiorcom API.
• Kluczowe funkcje:
  • Dokumentacja API (pliki Swagger)
  • Wdrożenie odbiorców
  • Pobieranie SDK
  • Rejestracja kluczy API i przepływy subskrypcji

 

Specyfikacje OpenAPI

• OpenAPI (Swagger): standardowy sposób opisywania REST API.
• API Gateway może importować i eksportować specyfikacje OpenAPI.

 

Czas na praktykę!

Tworzenie aplikacji na AWS