Amazon API Gateway Operations
External
Internal
Interacting with Amazon API Gateway
Amazon API Gateway Console
AWS CLI
Sending REST API Invocations
Using AWS SDK
HTTP Proxy Integration Example
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:
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 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:
API Testing
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:
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