API-ontwikkeling

Toepassingen ontwikkelen op AWS

Ricardo Sueiras

Principal Technologist

API Gateway-integraties

 

• Meerdere back-endintegratie-opties
• HTTP: elke publiek routeerbare endpoint
• AWS-service-API's zoals DynamoDB of SNS
• Lambda-functies
• Private resources via VPC-links
• Mock-responses zonder echte back-end

Integratietypen: proxy

 

• Integratietype bepaalt hoeveel controle API Gateway heeft
• Proxytypen: AWS_PROXY en HTTP_PROXY
• Hele HTTP-verzoek gaat direct naar de back-end
• API Gateway is een transparante doorgifte
• Back-end maakt de response

Integratietypen: non-proxy

• Non-proxytypen: AWS en HTTP
• Je configureert request- en response-transformaties
• Aangestuurd door mappingtemplates
• Templates in Velocity Template Language (VTL)

 

Requestvalidatie

 

• Valideer requests vóór ze de back-end bereiken
• Vangt ontbrekende verplichte velden
• Vangt ongeldige JSON-indeling
• Vangt onjuiste parametertypen
• Fouten geven meestal 400 Bad Request

Requestvalidatie

 

• Validatie kan omvatten:
  • Headers
  • Querystringparameters
  • Requestbody
  • JSON-schema

Requestvalidatie

 

• Validatie loont door:
  • Minder ongeldige back-endrequests
  • Lagere Lambda-uitvoeringskosten
  • Betrouwbaardere API's

Transformaties

• Vorm requests en responses om zonder back-endcode aan te passen
  • Wijzig payload-structuur
  • Hernoem velden
  • Transformeer headers
  • Converteer dataformaten
  • Verberg implementatiedetails
• Aangedreven door VTL-mappingtemplates

 

Fouten afhandelen

 

• Twee foutcategorieën
  • Gatewayfouten: opgewekt door API Gateway
  • Integratiefouten: back-endstoringen
• Veelvoorkomende gatewayfouten:
  • 400 Bad Request: requestvalidatie mislukt
  • 429 Too Many Requests: throttlinglimiet overschreden

Fouten afhandelen

 

• Veelvoorkomende integratiefouten:
  • 502 Bad Gateway: onjuiste of kapotte response
  • 503 Service Unavailable: back-end niet beschikbaar of overbelast
  • 504 Gateway Timeout: 29-seconden-time-out overschreden
  • Regionale en Private REST-API's kunnen langer dan 29 seconden gaan

Logging

• Uitvoeringslogs en CloudWatch-metrics zijn cruciale troubleshootingtools
• API Gateway integreert met CloudWatch voor:
  • Logs
  • Metrics
  • Execution tracing

 

 

Logging

• CloudWatch-logs helpen bij het oplossen van:
  • Mislukte integraties
  • Transformatiefouten
  • Autorisatiefouten
  • Lambda-uitvoeringsproblemen

 

 

Stages: API's beheren over omgevingen heen

 

• Eén API-definitie bedient meerdere omgevingen
• Stages zijn hoe API Gateway die omgevingen beheert

Stages: API's beheren over omgevingen heen

 

• Eén API-definitie bedient meerdere omgevingen
• Stages zijn hoe API Gateway die omgevingen beheert
• Een stage is een benoemde referentie
• Verwijst naar een deployment-snapshot van je API-config

Stages: API's beheren over omgevingen heen

 

• Eén API-definitie bedient meerdere omgevingen
• Stages zijn hoe API Gateway die omgevingen beheert
• Een stage is een benoemde referentie
• Verwijst naar een deployment-snapshot van je API-config
• Veelvoorkomende stagenamen:
  • Dev
  • Test
  • QA en Prod

Stages: API's beheren over omgevingen heen

 

• Eén API-definitie bedient meerdere omgevingen
• Stages zijn hoe API Gateway die omgevingen beheert
• Een stage is een benoemde referentie
• Verwijst naar een deployment-snapshot van je API-config
• Veelvoorkomende stagenamen: Dev, Test, QA, Prod
• De invoke-URL verschilt per stage

Stages: API's beheren over omgevingen heen

 

• Eén API-definitie bedient meerdere omgevingen
• Stages zijn hoe API Gateway die omgevingen beheert
• Een stage is een benoemde referentie
• Verwijst naar een deployment-snapshot van je API-config
• Veelvoorkomende stagenamen: Dev, Test, QA, Prod
• De invoke-URL verschilt per stage
• Meerdere stages kunnen naar één deployment wijzen voor directe rollback

Stages: API's beheren over omgevingen heen

 

• Wijzigingen gaan pas live na deployment naar een stage

Stage-mogelijkheden

• Elke stage configureer je apart
• Configuratie bevat stagevariabelen
• Stagevariabelen zijn key-valueparen
• Leid één deployment naar verschillende back-ends
• Geen redeployment nodig bij omgevingswijzigingen

 

Stage-mogelijkheden

• Canary-deployments
  • Alleen REST-API's
  • Stuur een percentage verkeer naar een nieuwe deployment
  • Promoveer naar volledige release
  • Verwijder de canary om terug te draaien

 

Stage-mogelijkheden

• Throttling
  • Ingesteld op stageniveau
  • Geldt voor alle methoden, met per-methode-overrides

 

Stage-mogelijkheden

• Throttling
  • Ingesteld op stageniveau
  • Geldt voor alle methoden, met per-methode-overrides
• Caching
  • Alleen REST-API's
  • Slaat back-endresponses op per stage
  • Clients omzeilen met Cache-Control
  • TTL van 0 tot 3600 seconden, standaard 300

 

Stage-mogelijkheden

• Logging biedt twee modi
  • Access logs
  • Gebouwd uit $context-variabelen, naar een CloudWatch-loggroep
  • Execution logs
  • Leggen volledige request- en response-details vast

 

Laten we oefenen!

Toepassingen ontwikkelen op AWS