Amazon API Gateway Operations

External

• https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started.html

Internal

• Amazon API Gateway
• Amazon API Gateway Deployment with CloudFormation

Examples

• Example of API Gateway HTTP Proxy Integration built with AWS Console
• Example of API Gateway Lambda Integration Example built with AWS Console
• Example of API Gateway Mock Integration built with CloudFormation
• Example of API Gateway HTTP Integration built with CloudFormation
• Example of API Gateway Lambda Integration built with CloudFormation

Interacting with Amazon API Gateway

AWS CLI

Command Line Operations

Amazon API Gateway Console

https://console.aws.amazon.com/apigateway

Amazon API Gateway and CloudFormation

Amazon API Gateway Deployment with CloudFormation

API Inspection

Resources

API Gateway Console -> APIs -> <API Name> -> Resources. The "Resources" pane shows the structure of the API as a tree of nodes.

Aslo:

Resources

Methods

API Gateway Console -> APIs -> <API Name> -> Resources -> Select a Resource node -> API methods defined on each resource are the leafs of the tree.

API Creation

With Amazon API Gateway Console: Create API.

Examples:

• API Gateway HTTP Proxy Integration Example

API Deployment

An API deployment happens in a stage.

API Gateway Console -> APIs -> <API Name> -> Actions -> Deploy API. This is where an existing or a new stage is specified.

Stage Manipulation

Stage Editor: API Gateway Console -> APIs -> <API Name> -> Stages -> <stage name>

Updating an Existing OpenAPI Definition

TODO:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-update.html
• https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html

Also see:

aws apigateway put-rest-api

Create a VPC Link

Amazon API Gateway -> VPC Links -> Create:

Add VPC Link

Name: playground

Description: Access to the playground cluster and ECS services.

Target NLB: playground-nlb. The previously created NLB should be accessible in the drop-down box.

If a network load balancer needs to be created, this is the procedure:

Create a Network Load Balancer

If the network load balancer is internet-facing, the VPC Link is not necessary, as the URLs exposes by the load balancer can be accessed directly.

Create.

Grant permissions to create VPC link: https://docs.aws.amazon.com/apigateway/latest/developerguide/grant-permissions-to-create-vpclink.html

Amazon API Gateway Importer

Amazon API Gateway Importer

Configuring CloudWatch Logging

Set Up CloudWatch API Logging in API Gateway

Also see:

Amazon API Gateway Logging