You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/core/event_handler/api_gateway.md
+55-7Lines changed: 55 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,8 @@ Event handler for Amazon API Gateway REST/HTTP APIs and Application Loader Balan
7
7
8
8
!!! todo "Change proxy types enum to match PascalCase"
9
9
10
+
!!! todo "Update `route` methods to include an example in docstring to improve developer experience"
11
+
10
12
### Key Features
11
13
12
14
* Lightweight routing to reduce boilerplate for API Gateway REST/HTTP API and ALB
@@ -15,20 +17,66 @@ Event handler for Amazon API Gateway REST/HTTP APIs and Application Loader Balan
15
17
* Built-in support for Decimals JSON encoding
16
18
* Support for dynamic path expressions
17
19
18
-
> Rest API simplification with function returns a Dict
19
-
> Support function returns a Response object which give fine-grained control of the headers
20
-
21
-
22
20
## Getting started
23
21
24
-
!!! todo "Supported event types"
25
-
26
22
### Required resources
27
23
28
-
!!! todo "API Gateway proxy template"
24
+
You must have an existing [API Gateway Proxy integration](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html){target="_blank"} or [ALB](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/lambda-functions.html){target="_blank"} configured to invoke your Lambda function. There is no additional permissions or dependencies required to use this utility.
25
+
26
+
This is the sample infrastructure we are using for the initial examples in this section.
27
+
28
+
=== "template.yml"
29
+
30
+
```yaml
31
+
AWSTemplateFormatVersion: '2010-09-09'
32
+
Transform: AWS::Serverless-2016-10-31
33
+
Description: Hello world event handler API Gateway
0 commit comments