DEV Community

Roman
Roman

Posted on • Originally published at romankurnovskii.com

AWS API Gateway Cheat Sheet

Image description

  • REST API, HTTP API, WebSocket API
  • Deployment - point-in-time snapshot of your API Gateway API
  • Endpoint - https://api-id.execute-api.region-id.amazonaws.com

    • Edge-optimized
    • Private
    • Regional
    • Stage - A logical reference to a lifecycle state of your API.
    • Route - URL path, Latency based routing,
    • Integration - Lambda, HTTP, Private VPC, CORS
    • Import/Export - Open API
    • AM User should have permission to enable logging
  • Amazon API Gateway is an AWS service for creating, publishing, maintaining, monitoring, and securing REST, HTTP, and WebSocket APIs at any scale.

  • Stage variables are name-value pairs that you can define as configuration attributes associated with a deployment stage of a REST API. The act like environment variables and can be used in your API setup and mapping templates.

  • With deployment stages in API Gateway you can manage multiple release stages for each API, such as: alpha, beta, and production. Using stage variables you can configure an API deployment stage to interact with different backend endpoints.

  • When you build an API Gateway API with standard Lambda integration using the API Gateway console, the console automatically adds the required permissions. However, when you set up a stage variable to call a Lambda function through our API, you must manually add these permissions.

  • Integration timeout for AWS, Lambda, Lambda proxy, HTTP, HTTP proxy - 50 ms to 29 seconds

  • You can enable API caching to cache your endpoint's responses, this reduces the number of calls made to your endpoint and improves the latency of requests to your API

  • AWS Gateway Integration types:

    • AWS_ Proxy - lambda proxy integration
    • HTTP - http custom integration
    • HTTP_PROXY - http proxy

Sentry image

Make it make sense

Make sense of fixing your code with straight-forward application monitoring.

Start debugging →

Top comments (0)

Redis image

Short-term memory for faster
AI agents

AI agents struggle with latency and context switching. Redis fixes it with a fast, in-memory layer for short-term context—plus native support for vectors and semi-structured data to keep real-time workflows on track.

Start building

👋 Kindness is contagious

Explore this compelling article, highly praised by the collaborative DEV Community. All developers, whether just starting out or already experienced, are invited to share insights and grow our collective expertise.

A quick “thank you” can lift someone’s spirits—drop your kudos in the comments!

On DEV, sharing experiences sparks innovation and strengthens our connections. If this post resonated with you, a brief note of appreciation goes a long way.

Get Started