Skip to content

Commit 56f1167

Browse files
committed
rename example APIGateway to APIGatewayV2 (fix 572)
1 parent 74e4efd commit 56f1167

File tree

13 files changed

+12
-9
lines changed

13 files changed

+12
-9
lines changed

Examples/APIGatewayV1/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# API Gateway
1+
# REST API Gateway
22

33
This is a simple example of an AWS Lambda function invoked through an Amazon API Gateway V1.
44

55
> [!NOTE]
6-
> This example uses the API Gateway V1 `Api` endpoint type, whereas the [API Gateway V2](https://github.com/swift-server/swift-aws-lambda-runtime/tree/main/Examples/APIGateway) example uses the `HttpApi` endpoint type. For more information, see [Choose between REST AIs and HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vs-rest.html).
6+
> This example uses the API Gateway V1 `Rest Api` endpoint type, whereas the [API Gateway V2](https://github.com/swift-server/swift-aws-lambda-runtime/tree/main/Examples/APIGateway) example uses the `HttpApi` endpoint type. For more information, see [Choose between REST APIs and HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vs-rest.html).
77
88
## Code
99

File renamed without changes.
File renamed without changes.

Examples/APIGateway+LambdaAuthorizer/README.md renamed to Examples/APIGatewayV2+LambdaAuthorizer/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Lambda Authorizer with API Gateway
1+
# Lambda Authorizer with HTTPS API Gateway
22

3-
This is an example of a Lambda Authorizer function. There are two Lambda functions in this example. The first one is the authorizer function. The second one is the business function. The business function is exposed through a REST API using the API Gateway. The API Gateway is configured to use the authorizer function to implement a custom logic to authorize the requests.
3+
This is an example of a Lambda Authorizer function. There are two Lambda functions in this example. The first one is the authorizer function. The second one is the business function. The business function is exposed through a REST API using the HTTPS API Gateway. The API Gateway is configured to use the authorizer function to implement a custom logic to authorize the requests.
44

55
>[!NOTE]
66
> If your application is protected by JWT tokens, it's recommended to use [the native JWT authorizer provided by the API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html). The Lambda authorizer is useful when you need to implement a custom authorization logic. See the [OAuth 2.0/JWT authorizer example for AWS SAM](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-controlling-access-to-apis-oauth2-authorizer.html) to learn how to use the native JWT authorizer with SAM.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

Examples/APIGateway/README.md renamed to Examples/APIGatewayV2/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
# API Gateway
1+
# HTTPS API Gateway
22

3-
This is a simple example of an AWS Lambda function invoked through an Amazon API Gateway.
3+
This is a simple example of an AWS Lambda function invoked through an Amazon HTTPS API Gateway.
4+
5+
> [!NOTE]
6+
> This example uses the API Gateway V2 `Http Api` endpoint type, whereas the [API Gateway V1](https://github.com/swift-server/swift-aws-lambda-runtime/tree/main/Examples/APIGatewayV1) example uses the `Rest Api` endpoint type. For more information, see [Choose between REST APIs and HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vs-rest.html).
47
58
## Code
69

0 commit comments

Comments
 (0)