Amazon API Gateway Concepts: Difference between revisions
No edit summary |
|||
Line 2: | Line 2: | ||
* https://docs.aws.amazon.com/apigateway/api-reference/resource/ | * https://docs.aws.amazon.com/apigateway/api-reference/resource/ | ||
* https://docs.aws.amazon.com/apigateway/api-reference/link-relation/ | |||
=Internal= | =Internal= |
Revision as of 23:46, 4 February 2019
External
- https://docs.aws.amazon.com/apigateway/api-reference/resource/
- https://docs.aws.amazon.com/apigateway/api-reference/link-relation/
Internal
REST and Hypermedia Concepts
Amazon Gateway URL
The URL is determined by a protocol (HTTP(S) or WSS), a hostname, a stage name and, for REST APIs, the resource path.
Amazon Gateway API Base URL
The hostname and the stage name determine the API's base URL.
Amazon Gateway Hostname
https://{restapi-id}.execute-api.{region}.amazonaws.com
Integration
Mapping Template
Amazon API Gateway Resources that Require Redeployment
RestApi
Resource
Method
RequestValidator
MethodResponse
Integration
IntegrationResponse
GatewayResponse
DocumentationPart
DocumentationVersion
Model
ApiKey
Authorizer
VpcLink
Amazon API Gateway Resources that Require Configuration Changes without Redeployment
Account
Deployment (API Deployment)
A Deployment resource represents a REST API deployment in Amazon API Gateway. The Deployment is like an executable of an API represented by a RestApi resource. Once an RestApi is created, it requires deployment and association with a stage to make it callable by its users. To call a deployed URL, clients submit requests against the API's URL.
Resource updates require redeploying the API, whereas configuration updates to not.
DomainName
BasePathMapping
Stage
An API stage is represented by a Stage resource and represents a named reference to a deployment, and at the same time, a snapshot of the API, including methods, integrations, models, mapping templates, Lambda authorizers, etc.
Usage
UsagePlan
API Documentation
See DocumentationPart and DocumentationVersion above.
X-Ray Integration
API request latency issues can be troubleshot by enabling AWS X-Ray. AWS X-Ray can be used to trance API requests and downstream services.