Amazon API Gateway Concepts: Difference between revisions
(→Stage) |
(→Stage) |
||
| Line 71: | Line 71: | ||
{{External|[https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/ Stage]}} | {{External|[https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/ Stage]}} | ||
An API stage is represented by a [https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/ Stage] resource and represents a snapshot of the API, including [[REST_and_Hypermedia#Method|methods]], [[#Integration|integrations]], [[#Model|models]], [[#Mapping_Template|mapping templates]], [[#Authorizer|Lambda authorizers]], etc. | An API stage is represented by a [https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/ Stage] resource and represents a named reference to a [[#Deployment|deployment]], and at the same time, a snapshot of the API, including [[REST_and_Hypermedia#Method|methods]], [[#Integration|integrations]], [[#Model|models]], [[#Mapping_Template|mapping templates]], [[#Authorizer|Lambda authorizers]], etc. | ||
==Usage== | ==Usage== | ||
Revision as of 22:54, 4 February 2019
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.