Vývoj API

Developing Applications on AWS

Ricardo Sueiras

Principal Technologist

Integrace API Gateway

 

• Více možností integrace back-endu
• HTTP: libovolný veřejně dostupný endpoint
• AWS service APIs jako DynamoDB nebo SNS
• Lambda funkce
• Privátní zdroje přes VPC links
• Mock odpovědi bez skutečného back-endu

Typy integrace: proxy

 

• Typ integrace určuje míru kontroly API Gateway
• Proxy typy: AWS_PROXY a HTTP_PROXY
• Celý HTTP požadavek je předán přímo back-endu
• API Gateway funguje jako transparentní průchodní vrstva
• Odpověď sestavuje back-end

Typy integrace: non-proxy

• Non-proxy typy: AWS a HTTP
• Sám/sama konfiguruješ transformace požadavků a odpovědí
• Řízeno mapovacími šablonami
• Šablony psané ve Velocity Template Language (VTL)

 

Validace požadavků

 

• Validace požadavků ještě před dosažením back-endu
• Zachytí chybějící povinná pole
• Zachytí neplatný formát JSON
• Zachytí nesprávné typy parametrů
• Chyby obvykle vrátí 400 Bad Request

Validace požadavků

 

• Validace může pokrývat:
  • Hlavičky
  • Parametry query stringu
  • Tělo požadavku
  • JSON schema

Validace požadavků

 

• Validace se vyplatí, protože:
  • Snižuje počet neplatných požadavků na back-end
  • Snižuje náklady na spouštění Lambda
  • Zvyšuje spolehlivost API

Transformace

• Úprava požadavků a odpovědí bez zásahu do kódu back-endu
  • Změna struktury payloadu
  • Přejmenování polí
  • Transformace hlaviček
  • Konverze datových formátů
  • Skrytí implementačních detailů
• Poháněno VTL mapovacími šablonami

 

Zpracování chyb

 

• Dvě kategorie chyb
  • Chyby brány: vyvolané API Gateway
  • Integrační chyby: selhání back-endu
• Časté chyby brány:
  • 400 Bad Request: neúspěšná validace požadavku
  • 429 Too Many Requests: překročen limit throttlingu

Zpracování chyb

 

• Časté integrační chyby:
  • 502 Bad Gateway: chybně formátovaná nebo neplatná odpověď
  • 503 Service Unavailable: back-end nedostupný nebo přetížený
  • 504 Gateway Timeout: překročen 29sekundový timeout
  • Regionální a privátní REST API mohou timeout prodloužit

Logování

• Protokoly spuštění a metriky CloudWatch jsou klíčové nástroje pro ladění
• API Gateway se integruje s CloudWatch pro:
  • Logy
  • Metriky
  • Trasování spuštění

 

 

Logování

• Logy CloudWatch pomáhají řešit:
  • Selhání integrací
  • Chyby transformací
  • Selhání autorizace
  • Problémy se spouštěním Lambda

 

 

Stage: správa API napříč prostředími

 

• Jedna definice API slouží více prostředím
• Stage jsou způsob, jak API Gateway tato prostředí spravuje

Stage: správa API napříč prostředími

 

• Jedna definice API slouží více prostředím
• Stage jsou způsob, jak API Gateway tato prostředí spravuje
• Stage je pojmenovaný odkaz
• Odkazuje na snímek nasazení konfigurace API

Stage: správa API napříč prostředími

 

• Jedna definice API slouží více prostředím
• Stage jsou způsob, jak API Gateway tato prostředí spravuje
• Stage je pojmenovaný odkaz
• Odkazuje na snímek nasazení konfigurace API
• Běžné názvy stage:
  • Dev
  • Test
  • QA a Prod

Stage: správa API napříč prostředími

 

• Jedna definice API slouží více prostředím
• Stage jsou způsob, jak API Gateway tato prostředí spravuje
• Stage je pojmenovaný odkaz
• Odkazuje na snímek nasazení konfigurace API
• Běžné názvy stage: Dev, Test, QA, Prod
• Invoke URL odráží každou stage

Stage: správa API napříč prostředími

 

• Jedna definice API slouží více prostředím
• Stage jsou způsob, jak API Gateway tato prostředí spravuje
• Stage je pojmenovaný odkaz
• Odkazuje na snímek nasazení konfigurace API
• Běžné názvy stage: Dev, Test, QA, Prod
• Invoke URL odráží každou stage
• Více stage může ukazovat na jedno nasazení pro okamžitý rollback

Stage: správa API napříč prostředími

 

• Změny se projeví až po nasazení do stage

Možnosti stage

• Každá stage se konfiguruje samostatně
• Konfigurace zahrnuje proměnné stage
• Proměnné stage jsou páry klíč–hodnota
• Jedno nasazení lze směrovat na různé back-endy
• Změna prostředí nevyžaduje nové nasazení

 

Možnosti stage

• Canary nasazení
  • Pouze pro REST API
  • Přesměruje procento provozu na nové nasazení
  • Možnost povýšit na plné nasazení
  • Smazání canary provede rollback

 

Možnosti stage

• Throttling
  • Nastavuje se na úrovni stage
  • Platí pro všechny metody, s přepsáním na úrovni konkrétní metody

 

Možnosti stage

• Throttling
  • Nastavuje se na úrovni stage
  • Platí pro všechny metody, s přepsáním na úrovni konkrétní metody
• Caching
  • Pouze pro REST API
  • Ukládá odpovědi back-endu na úrovni stage
  • Klienti mohou obejít pomocí Cache-Control
  • TTL od 0 do 3600 sekund, výchozí hodnota 300

 

Možnosti stage

• Logování nabízí dva režimy
  • Access logy
  • Sestaveny z proměnných $context, odesílány do skupiny logů CloudWatch
  • Execution logy
  • Zachycují úplný detail požadavku a odpovědi

 

Pojďme cvičit!

Developing Applications on AWS