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/events/http-api.md
+9-5
Original file line number
Diff line number
Diff line change
@@ -380,7 +380,7 @@ resources:
380
380
- Ref: YourCognitoUserPoolName
381
381
```
382
382
383
-
### Event / payload format
383
+
## Event / payload format
384
384
385
385
HTTP API offers only a 'proxy' option for Lambda integration where an event submitted to the function contains the details of HTTP request such as headers, query string parameters etc.
386
386
There are two formats for this event available (see [Working with AWS Lambda proxy integrations for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html)), with the default being 2.0. It is possible to downgrade to 1.0 version by specifying `payload`. The payload version could be configured globally as:
@@ -405,7 +405,7 @@ functions:
405
405
method: GET
406
406
```
407
407
408
-
### Detailed Metrics
408
+
## Detailed Metrics
409
409
410
410
With HTTP API we may configure detailed metrics that can be used setup monitoring and alerting in Cloudwatch.
411
411
@@ -417,7 +417,7 @@ provider:
417
417
metrics: true
418
418
```
419
419
420
-
### Tags
420
+
## Tags
421
421
422
422
When using HTTP API, it is possible to tag the corresponding API Gateway resources. By setting `provider.httpApi.useProviderTags` to `true`, all tags defined on `provider.tags` will be applied to API Gateway and API Gateway Stage.
423
423
@@ -433,7 +433,7 @@ In the above example, the tag project: myProject will be applied to API Gateway
433
433
434
434
_Note: If the API Gateway has any existing tags applied outside of Serverless Framework, they will be removed during deployment._
435
435
436
-
### Disable Default Endpoint
436
+
## Disable Default Endpoint
437
437
438
438
By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
439
439
@@ -443,14 +443,18 @@ provider:
443
443
disableDefaultEndpoint: true
444
444
```
445
445
446
-
### Service Naming
446
+
## Service Naming
447
447
448
448
You can use the `shouldStartNameWithService` option to change the naming scheme for HTTP API from the default `${stage}-${service}` to `${service}-${stage}`.
449
449
450
+
You can also define your own name for the API instead of the default generated one and also define a description for it.
0 commit comments