文档 AWS SDK 示例 GitHub 存储库中还有更多 [S AWS DK 示例](https://github.com/awsdocs/aws-doc-sdk-examples)。
本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
# 使用 API Gateway 的代码示例 AWS SDKs
以下代码示例向您展示了如何将 Amazon API Gateway 与 AWS 软件开发套件 (SDK) 配合使用。
*操作*是大型程序的代码摘录，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景的上下文查看操作。
*场景*是向您展示如何通过在一个服务中调用多个函数或与其他 AWS 服务服务结合来完成特定任务的代码示例。
*AWS 社区贡献*就是由多个团队创建和维护的示例 AWS。要提供反馈，请使用链接存储库中提供的机制。
**更多资源**
+ **[API Gateway 开发人员指南](https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html)**——有关 API Gateway 的更多信息。
+ **[API Gateway API 参考](https://docs.aws.amazon.com/apigateway/latest/api/API_Operations.html)**——有关所有可用的 API Gateway 操作的详细信息。
+ **[AWS 开发者中心](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23api-gateway)** — 您可以按类别或全文搜索筛选的代码示例。
+ **[AWS SDK 示例](https://github.com/awsdocs/aws-doc-sdk-examples)** — 包含首选语言完整代码的 GitHub 存储库。包括有关设置和运行代码的说明。
**Contents**
+ [基本功能](api-gateway_code_examples_basics.md)
+ [操作](api-gateway_code_examples_actions.md)
+ [`CreateDeployment`](api-gateway_example_api-gateway_CreateDeployment_section.md)
+ [`CreateResource`](api-gateway_example_api-gateway_CreateResource_section.md)
+ [`CreateRestApi`](api-gateway_example_api-gateway_CreateRestApi_section.md)
+ [`DeleteDeployment`](api-gateway_example_api-gateway_DeleteDeployment_section.md)
+ [`DeleteRestApi`](api-gateway_example_api-gateway_DeleteRestApi_section.md)
+ [`GetBasePathMapping`](api-gateway_example_api-gateway_GetBasePathMapping_section.md)
+ [`GetResources`](api-gateway_example_api-gateway_GetResources_section.md)
+ [`GetRestApis`](api-gateway_example_api-gateway_GetRestApis_section.md)
+ [`ListBasePathMappings`](api-gateway_example_api-gateway_ListBasePathMappings_section.md)
+ [`PutIntegration`](api-gateway_example_api-gateway_PutIntegration_section.md)
+ [`PutIntegrationResponse`](api-gateway_example_api-gateway_PutIntegrationResponse_section.md)
+ [`PutMethod`](api-gateway_example_api-gateway_PutMethod_section.md)
+ [`PutMethodResponse`](api-gateway_example_api-gateway_PutMethodResponse_section.md)
+ [`UpdateBasePathMapping`](api-gateway_example_api-gateway_UpdateBasePathMapping_section.md)
+ [场景](api-gateway_code_examples_scenarios.md)
+ [创建 REST API 以跟踪 COVID-19 数据](api-gateway_example_cross_ApiGatewayDataTracker_section.md)
+ [创建借阅图书馆 REST API](api-gateway_example_cross_AuroraRestLendingLibrary_section.md)
+ [创建无服务器应用程序来管理照片](api-gateway_example_cross_PAM_section.md)
+ [创建 Websocket 聊天应用程序](api-gateway_example_cross_ApiGatewayWebsocketChat_section.md)
+ [创建并部署 REST API](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
+ [使用 API Gateway 调用 Lambda 函数](api-gateway_example_cross_LambdaAPIGateway_section.md)
+ [AWS 社区捐款](api-gateway_code_examples_aws_community_contributions.md)
+ [构建和测试无服务器应用程序](api-gateway_example_tributary-lite_serverless-application_section.md)
# 使用 API Gateway 的基本示例 AWS SDKs
以下代码示例展示了如何使用 Amazon API Gateway 的基础知识 AWS SDKs。
**Contents**
+ [操作](api-gateway_code_examples_actions.md)
+ [`CreateDeployment`](api-gateway_example_api-gateway_CreateDeployment_section.md)
+ [`CreateResource`](api-gateway_example_api-gateway_CreateResource_section.md)
+ [`CreateRestApi`](api-gateway_example_api-gateway_CreateRestApi_section.md)
+ [`DeleteDeployment`](api-gateway_example_api-gateway_DeleteDeployment_section.md)
+ [`DeleteRestApi`](api-gateway_example_api-gateway_DeleteRestApi_section.md)
+ [`GetBasePathMapping`](api-gateway_example_api-gateway_GetBasePathMapping_section.md)
+ [`GetResources`](api-gateway_example_api-gateway_GetResources_section.md)
+ [`GetRestApis`](api-gateway_example_api-gateway_GetRestApis_section.md)
+ [`ListBasePathMappings`](api-gateway_example_api-gateway_ListBasePathMappings_section.md)
+ [`PutIntegration`](api-gateway_example_api-gateway_PutIntegration_section.md)
+ [`PutIntegrationResponse`](api-gateway_example_api-gateway_PutIntegrationResponse_section.md)
+ [`PutMethod`](api-gateway_example_api-gateway_PutMethod_section.md)
+ [`PutMethodResponse`](api-gateway_example_api-gateway_PutMethodResponse_section.md)
+ [`UpdateBasePathMapping`](api-gateway_example_api-gateway_UpdateBasePathMapping_section.md)
# 使用 API Gateway 执行的操作 AWS SDKs
以下代码示例演示了如何使用执行各个 API Gateway 操作 AWS SDKs。每个示例都包含一个指向的链接 GitHub，您可以在其中找到有关设置和运行代码的说明。
这些代码节选调用了 API Gateway API，是必须在上下文中运行的大型程序的代码节选。您可以在[API Gateway 使用的场景 AWS SDKs](api-gateway_code_examples_scenarios.md)中结合上下文查看操作。
以下示例仅包括最常用的操作。有关完整列表，请参阅 [Amazon API Gateway API 参考](https://docs.aws.amazon.com/apigateway/latest/api/API_Operations.html)。
**Topics**
+ [`CreateDeployment`](api-gateway_example_api-gateway_CreateDeployment_section.md)
+ [`CreateResource`](api-gateway_example_api-gateway_CreateResource_section.md)
+ [`CreateRestApi`](api-gateway_example_api-gateway_CreateRestApi_section.md)
+ [`DeleteDeployment`](api-gateway_example_api-gateway_DeleteDeployment_section.md)
+ [`DeleteRestApi`](api-gateway_example_api-gateway_DeleteRestApi_section.md)
+ [`GetBasePathMapping`](api-gateway_example_api-gateway_GetBasePathMapping_section.md)
+ [`GetResources`](api-gateway_example_api-gateway_GetResources_section.md)
+ [`GetRestApis`](api-gateway_example_api-gateway_GetRestApis_section.md)
+ [`ListBasePathMappings`](api-gateway_example_api-gateway_ListBasePathMappings_section.md)
+ [`PutIntegration`](api-gateway_example_api-gateway_PutIntegration_section.md)
+ [`PutIntegrationResponse`](api-gateway_example_api-gateway_PutIntegrationResponse_section.md)
+ [`PutMethod`](api-gateway_example_api-gateway_PutMethod_section.md)
+ [`PutMethodResponse`](api-gateway_example_api-gateway_PutMethodResponse_section.md)
+ [`UpdateBasePathMapping`](api-gateway_example_api-gateway_UpdateBasePathMapping_section.md)
# `CreateDeployment`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `CreateDeployment`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [创建并部署 REST API](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**将为 API 配置的资源部署到新阶段**
命令:
```
aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --stage-description 'Development Stage' --description 'First deployment to the dev stage'
```
**将为 API 配置的资源部署到现有阶段**
命令:
```
aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --description 'Second deployment to the dev stage'
```
**通过 Stage 变量将为 API 配置的资源部署到现有阶段**
aws apigateway 创建部署 — rest-api-id 1234123412 — stage-name dev — 描述 “第三次部署到开发阶段” — variables key='value '，otherkey='otherValue'，otherkey='otherValue'
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-deployment.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/apigateway#code-examples)中查找完整示例，了解如何进行设置和运行。
```
public static String createNewDeployment(ApiGatewayClient apiGateway, String restApiId, String stageName) {
try {
CreateDeploymentRequest request = CreateDeploymentRequest.builder()
.restApiId(restApiId)
.description("Created using the AWS API Gateway Java API")
.stageName(stageName)
.build();
CreateDeploymentResponse response = apiGateway.createDeployment(request);
System.out.println("The id of the deployment is " + response.id());
return response.id();
} catch (ApiGatewayException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return "";
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[CreateDeployment](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateDeployment)*中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def deploy_api(self, stage_name):
"""
Deploys a REST API. After a REST API is deployed, it can be called from any
REST client, such as the Python Requests package or Postman.
:param stage_name: The stage of the API to deploy, such as 'test'.
:return: The base URL of the deployed REST API.
"""
try:
self.apig_client.create_deployment(
restApiId=self.api_id, stageName=stage_name
)
self.stage = stage_name
logger.info("Deployed stage %s.", stage_name)
except ClientError:
logger.exception("Couldn't deploy stage %s.", stage_name)
raise
else:
return self.api_url()
def api_url(self, resource=None):
"""
Builds the REST API URL from its parts.
:param resource: The resource path to append to the base URL.
:return: The REST URL to the specified resource.
"""
url = (
f"https://{self.api_id}.execute-api.{self.apig_client.meta.region_name}"
f".amazonaws.com/{self.stage}"
)
if resource is not None:
url = f"{url}/{resource}"
return url
```
+ 有关 API 的详细信息，请参阅适用[CreateDeployment](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateDeployment)于 *Python 的AWS SDK (Boto3) API 参考*。
------
#### [ SAP ABAP ]
**适用于 SAP ABAP 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples)中查找完整示例，了解如何进行设置和运行。
```
TRY.
oo_result = lo_agw->createdeployment(
iv_restapiid = iv_rest_api_id
iv_stagename = iv_stage_name
iv_description = 'Deployment created by ABAP SDK' ).
DATA(lv_deployment_id) = oo_result->get_id( ).
MESSAGE 'Deployment created with ID: ' && lv_deployment_id TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwnotfoundexception INTO DATA(lo_not_found).
MESSAGE lo_not_found->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
ENDTRY.
```
+ 有关 API 的详细信息，请参阅适用[CreateDeployment](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)于 S *AP 的AWS SDK ABAP API 参考*。
------
# `CreateResource`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `CreateResource`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [创建并部署 REST API](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**在 API 中创建资源**
命令:
```
aws apigateway create-resource --rest-api-id 1234123412 --parent-id a1b2c3 --path-part 'new-resource'
```
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-resource.html)*中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def add_rest_resource(self, parent_id, resource_path):
"""
Adds a resource to a REST API.
:param parent_id: The ID of the parent resource.
:param resource_path: The path of the new resource, relative to the parent.
:return: The ID of the new resource.
"""
try:
result = self.apig_client.create_resource(
restApiId=self.api_id, parentId=parent_id, pathPart=resource_path
)
resource_id = result["id"]
logger.info("Created resource %s.", resource_path)
except ClientError:
logger.exception("Couldn't create resource %s.", resource_path)
raise
else:
return resource_id
```
+ 有关 API 的详细信息，请参阅适用[CreateResource](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateResource)于 *Python 的AWS SDK (Boto3) API 参考*。
------
#### [ SAP ABAP ]
**适用于 SAP ABAP 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples)中查找完整示例，了解如何进行设置和运行。
```
TRY.
oo_result = lo_agw->createresource(
iv_restapiid = iv_rest_api_id
iv_parentid = iv_parent_id
iv_pathpart = iv_resource_path ).
DATA(lv_resource_id) = oo_result->get_id( ).
MESSAGE 'Resource created with ID: ' && lv_resource_id TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwnotfoundexception INTO DATA(lo_not_found).
MESSAGE lo_not_found->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
ENDTRY.
```
+ 有关 API 的详细信息，请参阅适用[CreateResource](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)于 S *AP 的AWS SDK ABAP API 参考*。
------
# `CreateRestApi`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `CreateRestApi`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [创建并部署 REST API](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**创建 API**
命令:
```
aws apigateway create-rest-api --name 'My First API' --description 'This is my first API'
```
**使用现有 API 创建重复的 API**
命令:
```
aws apigateway create-rest-api --name 'Copy of My First API' --description 'This is a copy of my first API' --clone-from 1234123412
```
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateRestApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-rest-api.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/apigateway#code-examples)中查找完整示例，了解如何进行设置和运行。
```
public static String createAPI(ApiGatewayClient apiGateway, String restApiId, String restApiName) {
try {
CreateRestApiRequest request = CreateRestApiRequest.builder()
.cloneFrom(restApiId)
.description("Created using the Gateway Java API")
.name(restApiName)
.build();
CreateRestApiResponse response = apiGateway.createRestApi(request);
System.out.println("The id of the new api is " + response.id());
return response.id();
} catch (ApiGatewayException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return "";
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[CreateRestApi](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateRestApi)*中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def create_rest_api(self, api_name):
"""
Creates a REST API on API Gateway. The default API has only a root resource
and no HTTP methods.
:param api_name: The name of the API. This descriptive name is not used in
the API path.
:return: The ID of the newly created API.
"""
try:
result = self.apig_client.create_rest_api(name=api_name)
self.api_id = result["id"]
logger.info("Created REST API %s with ID %s.", api_name, self.api_id)
except ClientError:
logger.exception("Couldn't create REST API %s.", api_name)
raise
try:
result = self.apig_client.get_resources(restApiId=self.api_id)
self.root_id = next(
item for item in result["items"] if item["path"] == "/"
)["id"]
except ClientError:
logger.exception("Couldn't get resources for API %s.", self.api_id)
raise
except StopIteration as err:
logger.exception("No root resource found in API %s.", self.api_id)
raise ValueError from err
return self.api_id
```
+ 有关 API 的详细信息，请参阅适用[CreateRestApi](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateRestApi)于 *Python 的AWS SDK (Boto3) API 参考*。
------
#### [ SAP ABAP ]
**适用于 SAP ABAP 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples)中查找完整示例，了解如何进行设置和运行。
```
TRY.
oo_result = lo_agw->createrestapi(
iv_name = iv_api_name
iv_description = 'Sample REST API created by ABAP SDK' ).
DATA(lv_api_id) = oo_result->get_id( ).
MESSAGE 'REST API created with ID: ' && lv_api_id TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
CATCH /aws1/cx_agwunauthorizedex INTO DATA(lo_unauthorized).
MESSAGE lo_unauthorized->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_unauthorized.
ENDTRY.
```
+ 有关 API 的详细信息，请参阅适用[CreateRestApi](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)于 S *AP 的AWS SDK ABAP API 参考*。
------
# `DeleteDeployment`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `DeleteDeployment`。
------
#### [ CLI ]
**AWS CLI**
**在 API 中删除部署**
命令:
```
aws apigateway delete-deployment --rest-api-id 1234123412 --deployment-id a1b2c3
```
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-deployment.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/apigateway#code-examples)中查找完整示例，了解如何进行设置和运行。
```
public static void deleteSpecificDeployment(ApiGatewayClient apiGateway, String restApiId, String deploymentId) {
try {
DeleteDeploymentRequest request = DeleteDeploymentRequest.builder()
.restApiId(restApiId)
.deploymentId(deploymentId)
.build();
apiGateway.deleteDeployment(request);
System.out.println("Deployment was deleted");
} catch (ApiGatewayException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[DeleteDeployment](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteDeployment)*中的。
------
# `DeleteRestApi`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `DeleteRestApi`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [创建并部署 REST API](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**删除 API**
命令:
```
aws apigateway delete-rest-api --rest-api-id 1234123412
```
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[DeleteRestApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-rest-api.html)*中的。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/apigateway#code-examples)中查找完整示例，了解如何进行设置和运行。
```
public static void deleteAPI(ApiGatewayClient apiGateway, String restApiId) {
try {
DeleteRestApiRequest request = DeleteRestApiRequest.builder()
.restApiId(restApiId)
.build();
apiGateway.deleteRestApi(request);
System.out.println("The API was successfully deleted");
} catch (ApiGatewayException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ 有关 API 的详细信息，请参阅 *AWS SDK for Java 2.x API 参考[DeleteRestApi](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteRestApi)*中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def delete_rest_api(self):
"""
Deletes a REST API, including all of its resources and configuration.
"""
try:
self.apig_client.delete_rest_api(restApiId=self.api_id)
logger.info("Deleted REST API %s.", self.api_id)
self.api_id = None
except ClientError:
logger.exception("Couldn't delete REST API %s.", self.api_id)
raise
```
+ 有关 API 的详细信息，请参阅适用[DeleteRestApi](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteRestApi)于 *Python 的AWS SDK (Boto3) API 参考*。
------
#### [ SAP ABAP ]
**适用于 SAP ABAP 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples)中查找完整示例，了解如何进行设置和运行。
```
TRY.
lo_agw->deleterestapi(
iv_restapiid = iv_rest_api_id ).
MESSAGE 'REST API deleted successfully' TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwnotfoundexception INTO DATA(lo_not_found).
MESSAGE lo_not_found->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
ENDTRY.
```
+ 有关 API 的详细信息，请参阅适用[DeleteRestApi](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)于 S *AP 的AWS SDK ABAP API 参考*。
------
# `GetBasePathMapping`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `GetBasePathMapping`。
------
#### [ CLI ]
**AWS CLI**
**获取自定义域名的一个基础路径映射**
命令:
```
aws apigateway get-base-path-mapping --domain-name subdomain.domain.tld --base-path v1
```
输出：
```
{
"basePath": "v1",
"restApiId": "1234w4321e",
"stage": "api"
}
```
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[GetBasePathMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-base-path-mapping.html)*中的。
------
#### [ PHP ]
**适用于 PHP 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/apigateway#code-examples)中查找完整示例，了解如何进行设置和运行。
```
require 'vendor/autoload.php';
use Aws\ApiGateway\ApiGatewayClient;
use Aws\Exception\AwsException;
/* ////////////////////////////////////////////////////////////////////////////
* Purpose: Gets the base path mapping for a custom domain name in
* Amazon API Gateway.
*
* Prerequisites: A custom domain name in API Gateway. For more information,
* see "Custom Domain Names" in the Amazon API Gateway Developer Guide.
*
* Inputs:
* - $apiGatewayClient: An initialized AWS SDK for PHP API client for
* API Gateway.
* - $basePath: The base path name that callers must provide as part of the
* URL after the domain name.
* - $domainName: The custom domain name for the base path mapping.
*
* Returns: The base path mapping, if available; otherwise, the error message.
* ///////////////////////////////////////////////////////////////////////// */
function getBasePathMapping($apiGatewayClient, $basePath, $domainName)
{
try {
$result = $apiGatewayClient->getBasePathMapping([
'basePath' => $basePath,
'domainName' => $domainName,
]);
return 'The base path mapping\'s effective URI is: ' .
$result['@metadata']['effectiveUri'];
} catch (AwsException $e) {
return 'Error: ' . $e['message'];
}
}
function getsTheBasePathMapping()
{
$apiGatewayClient = new ApiGatewayClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2015-07-09'
]);
echo getBasePathMapping($apiGatewayClient, '(none)', 'example.com');
}
// Uncomment the following line to run this code in an AWS account.
// getsTheBasePathMapping();
```
+ 有关 API 的详细信息，请参阅 *适用于 PHP 的 AWS SDK API 参考[GetBasePathMapping](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetBasePathMapping)*中的。
------
# `GetResources`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `GetResources`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [创建并部署 REST API](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**获取 REST API 的资源列表**
命令:
```
aws apigateway get-resources --rest-api-id 1234123412
```
输出：
```
{
"items": [
{
"path": "/resource/subresource",
"resourceMethods": {
"POST": {}
},
"id": "024ace",
"pathPart": "subresource",
"parentId": "ai5b02"
}
]
}
```
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[GetResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-resources.html)*中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def create_rest_api(self, api_name):
"""
Creates a REST API on API Gateway. The default API has only a root resource
and no HTTP methods.
:param api_name: The name of the API. This descriptive name is not used in
the API path.
:return: The ID of the newly created API.
"""
try:
result = self.apig_client.create_rest_api(name=api_name)
self.api_id = result["id"]
logger.info("Created REST API %s with ID %s.", api_name, self.api_id)
except ClientError:
logger.exception("Couldn't create REST API %s.", api_name)
raise
try:
result = self.apig_client.get_resources(restApiId=self.api_id)
self.root_id = next(
item for item in result["items"] if item["path"] == "/"
)["id"]
except ClientError:
logger.exception("Couldn't get resources for API %s.", self.api_id)
raise
except StopIteration as err:
logger.exception("No root resource found in API %s.", self.api_id)
raise ValueError from err
return self.api_id
```
+ 有关 API 的详细信息，请参阅适用[GetResources](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetResources)于 *Python 的AWS SDK (Boto3) API 参考*。
------
#### [ SAP ABAP ]
**适用于 SAP ABAP 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples)中查找完整示例，了解如何进行设置和运行。
```
TRY.
oo_result = lo_agw->getresources(
iv_restapiid = iv_rest_api_id ).
DATA(lt_resources) = oo_result->get_items( ).
DATA(lv_count) = lines( lt_resources ).
MESSAGE 'Found ' && lv_count && ' resources' TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwnotfoundexception INTO DATA(lo_not_found).
MESSAGE lo_not_found->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
ENDTRY.
```
+ 有关 API 的详细信息，请参阅适用[GetResources](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)于 S *AP 的AWS SDK ABAP API 参考*。
------
# `GetRestApis`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `GetRestApis`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [创建并部署 REST API](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**要获取 REST 列表 APIs**
命令:
```
aws apigateway get-rest-apis
```
输出：
```
{
"items": [
{
"createdDate": 1438884790,
"id": "12s44z21rb",
"name": "My First API"
}
]
}
```
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[GetRestApis](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-rest-apis.html)*中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def get_rest_api_id(self, api_name):
"""
Gets the ID of a REST API from its name by searching the list of REST APIs
for the current account. Because names need not be unique, this returns only
the first API with the specified name.
:param api_name: The name of the API to look up.
:return: The ID of the specified API.
"""
try:
rest_api = None
paginator = self.apig_client.get_paginator("get_rest_apis")
for page in paginator.paginate():
rest_api = next(
(item for item in page["items"] if item["name"] == api_name), None
)
if rest_api is not None:
break
self.api_id = rest_api["id"]
logger.info("Found ID %s for API %s.", rest_api["id"], api_name)
except ClientError:
logger.exception("Couldn't find ID for API %s.", api_name)
raise
else:
return rest_api["id"]
```
+ 有关 API 的详细信息，请参阅适用[GetRestApis](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetRestApis)于 *Python 的AWS SDK (Boto3) API 参考*。
------
#### [ Rust ]
**适用于 Rust 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/apigateway#code-examples)中查找完整示例，了解如何进行设置和运行。
显示该地区的 Amazon API Gateway REST APIs 。
```
async fn show_apis(client: &Client) -> Result<(), Error> {
let resp = client.get_rest_apis().send().await?;
for api in resp.items() {
println!("ID: {}", api.id().unwrap_or_default());
println!("Name: {}", api.name().unwrap_or_default());
println!("Description: {}", api.description().unwrap_or_default());
println!("Version: {}", api.version().unwrap_or_default());
println!(
"Created: {}",
api.created_date().unwrap().to_chrono_utc()?
);
println!();
}
Ok(())
}
```
+ 有关 API 的详细信息，请参阅适用[GetRestApis](https://docs.rs/aws-sdk-apigateway/latest/aws_sdk_apigateway/client/struct.Client.html#method.get_rest_apis)于 *Rust 的AWS SDK API 参考*。
------
#### [ SAP ABAP ]
**适用于 SAP ABAP 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples)中查找完整示例，了解如何进行设置和运行。
```
TRY.
oo_result = lo_agw->getrestapis( ).
DATA(lt_apis) = oo_result->get_items( ).
DATA(lv_count) = lines( lt_apis ).
MESSAGE 'Found ' && lv_count && ' REST APIs' TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
ENDTRY.
```
+ 有关 API 的详细信息，请参阅适用[GetRestApis](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)于 S *AP 的AWS SDK ABAP API 参考*。
------
# `ListBasePathMappings`与 AWS SDK 一起使用
以下代码示例演示了如何使用 `ListBasePathMappings`。
------
#### [ PHP ]
**适用于 PHP 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/apigateway#code-examples)中查找完整示例，了解如何进行设置和运行。
```
require 'vendor/autoload.php';
use Aws\ApiGateway\ApiGatewayClient;
use Aws\Exception\AwsException;
/* ////////////////////////////////////////////////////////////////////////////
* Purpose: Lists the base path mapping for a custom domain name in
* Amazon API Gateway.
*
* Prerequisites: A custom domain name in API Gateway. For more information,
* see "Custom Domain Names" in the Amazon API Gateway Developer Guide.
*
* Inputs:
* - $apiGatewayClient: An initialized AWS SDK for PHP API client for
* API Gateway.
* - $domainName: The custom domain name for the base path mappings.
*
* Returns: Information about the base path mappings, if available;
* otherwise, the error message.
* ///////////////////////////////////////////////////////////////////////// */
function listBasePathMappings($apiGatewayClient, $domainName)
{
try {
$result = $apiGatewayClient->getBasePathMappings([
'domainName' => $domainName
]);
return 'The base path mapping(s) effective URI is: ' .
$result['@metadata']['effectiveUri'];
} catch (AwsException $e) {
return 'Error: ' . $e['message'];
}
}
function listTheBasePathMappings()
{
$apiGatewayClient = new ApiGatewayClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2015-07-09'
]);
echo listBasePathMappings($apiGatewayClient, 'example.com');
}
// Uncomment the following line to run this code in an AWS account.
// listTheBasePathMappings();
```
+ 有关 API 的详细信息，请参阅 *适用于 PHP 的 AWS SDK API 参考[ListBasePathMappings](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/ListBasePathMappings)*中的。
------
# `PutIntegration`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `PutIntegration`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [创建并部署 REST API](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**创建 MOCK 集成请求**
命令:
```
aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type MOCK --request-templates '{ "application/json": "{\"statusCode\": 200}" }'
```
**创建 HTTP 集成请求**
命令:
```
aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type HTTP --integration-http-method GET --uri 'https://domain.tld/path'
```
**使用 Lambda 函数终端节点创建 AWS 集成请求**
命令:
```
aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type AWS --integration-http-method POST --uri 'arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:function_name/invocations'
```
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[PutIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/put-integration.html)*中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def add_integration_method(
self,
resource_id,
rest_method,
service_endpoint_prefix,
service_action,
service_method,
role_arn,
mapping_template,
):
"""
Adds an integration method to a REST API. An integration method is a REST
resource, such as '/users', and an HTTP verb, such as GET. The integration
method is backed by an AWS service, such as Amazon DynamoDB.
:param resource_id: The ID of the REST resource.
:param rest_method: The HTTP verb used with the REST resource.
:param service_endpoint_prefix: The service endpoint that is integrated with
this method, such as 'dynamodb'.
:param service_action: The action that is called on the service, such as
'GetItem'.
:param service_method: The HTTP method of the service request, such as POST.
:param role_arn: The Amazon Resource Name (ARN) of a role that grants API
Gateway permission to use the specified action with the
service.
:param mapping_template: A mapping template that is used to translate REST
elements, such as query parameters, to the request
body format required by the service.
"""
service_uri = (
f"arn:aws:apigateway:{self.apig_client.meta.region_name}"
f":{service_endpoint_prefix}:action/{service_action}"
)
try:
self.apig_client.put_method(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
authorizationType="NONE",
)
self.apig_client.put_method_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseModels={"application/json": "Empty"},
)
logger.info("Created %s method for resource %s.", rest_method, resource_id)
except ClientError:
logger.exception(
"Couldn't create %s method for resource %s.", rest_method, resource_id
)
raise
try:
self.apig_client.put_integration(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
type="AWS",
integrationHttpMethod=service_method,
credentials=role_arn,
requestTemplates={"application/json": json.dumps(mapping_template)},
uri=service_uri,
passthroughBehavior="WHEN_NO_TEMPLATES",
)
self.apig_client.put_integration_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseTemplates={"application/json": ""},
)
logger.info(
"Created integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
except ClientError:
logger.exception(
"Couldn't create integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
raise
```
+ 有关 API 的详细信息，请参阅适用[PutIntegration](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutIntegration)于 *Python 的AWS SDK (Boto3) API 参考*。
------
#### [ SAP ABAP ]
**适用于 SAP ABAP 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples)中查找完整示例，了解如何进行设置和运行。
```
TRY.
oo_result = lo_agw->putintegration(
iv_restapiid = iv_rest_api_id
iv_resourceid = iv_resource_id
iv_httpmethod = iv_http_method
iv_type = 'AWS_PROXY'
iv_integrationhttpmethod = 'POST'
iv_uri = iv_integration_uri ).
MESSAGE 'Integration configured for method' TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwnotfoundexception INTO DATA(lo_not_found).
MESSAGE lo_not_found->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
ENDTRY.
```
+ 有关 API 的详细信息，请参阅适用[PutIntegration](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)于 S *AP 的AWS SDK ABAP API 参考*。
------
# `PutIntegrationResponse`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `PutIntegrationResponse`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [创建并部署 REST API](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**使用定义的映射模板创建集成响应作为默认响应**
命令:
```
aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --selection-pattern "" --response-templates '{"application/json": "{\"json\": \"template\"}"}'
```
**使用正则表达式为 400 的静态定义的标头值创建集成响应**
命令:
```
aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 400 --selection-pattern 400 --response-parameters '{"method.response.header.custom-header": "'"'"'custom-value'"'"'"}'
```
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[PutIntegrationResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/put-integration-response.html)*中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def add_integration_method(
self,
resource_id,
rest_method,
service_endpoint_prefix,
service_action,
service_method,
role_arn,
mapping_template,
):
"""
Adds an integration method to a REST API. An integration method is a REST
resource, such as '/users', and an HTTP verb, such as GET. The integration
method is backed by an AWS service, such as Amazon DynamoDB.
:param resource_id: The ID of the REST resource.
:param rest_method: The HTTP verb used with the REST resource.
:param service_endpoint_prefix: The service endpoint that is integrated with
this method, such as 'dynamodb'.
:param service_action: The action that is called on the service, such as
'GetItem'.
:param service_method: The HTTP method of the service request, such as POST.
:param role_arn: The Amazon Resource Name (ARN) of a role that grants API
Gateway permission to use the specified action with the
service.
:param mapping_template: A mapping template that is used to translate REST
elements, such as query parameters, to the request
body format required by the service.
"""
service_uri = (
f"arn:aws:apigateway:{self.apig_client.meta.region_name}"
f":{service_endpoint_prefix}:action/{service_action}"
)
try:
self.apig_client.put_method(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
authorizationType="NONE",
)
self.apig_client.put_method_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseModels={"application/json": "Empty"},
)
logger.info("Created %s method for resource %s.", rest_method, resource_id)
except ClientError:
logger.exception(
"Couldn't create %s method for resource %s.", rest_method, resource_id
)
raise
try:
self.apig_client.put_integration(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
type="AWS",
integrationHttpMethod=service_method,
credentials=role_arn,
requestTemplates={"application/json": json.dumps(mapping_template)},
uri=service_uri,
passthroughBehavior="WHEN_NO_TEMPLATES",
)
self.apig_client.put_integration_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseTemplates={"application/json": ""},
)
logger.info(
"Created integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
except ClientError:
logger.exception(
"Couldn't create integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
raise
```
+ 有关 API 的详细信息，请参阅适用[PutIntegrationResponse](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutIntegrationResponse)于 *Python 的AWS SDK (Boto3) API 参考*。
------
#### [ SAP ABAP ]
**适用于 SAP ABAP 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples)中查找完整示例，了解如何进行设置和运行。
```
TRY.
oo_result = lo_agw->putintegrationresponse(
iv_restapiid = iv_rest_api_id
iv_resourceid = iv_resource_id
iv_httpmethod = iv_http_method
iv_statuscode = '200' ).
MESSAGE 'Integration response configured for status 200' TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwnotfoundexception INTO DATA(lo_not_found).
MESSAGE lo_not_found->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
ENDTRY.
```
+ 有关 API 的详细信息，请参阅适用[PutIntegrationResponse](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)于 S *AP 的AWS SDK ABAP API 参考*。
------
# `PutMethod`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `PutMethod`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [创建并部署 REST API](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**在没有授权、没有 API 密钥和自定义方法请求标头的情况下为 API 中的资源创建方法**
命令:
```
aws apigateway put-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method PUT --authorization-type "NONE" --no-api-key-required --request-parameters "method.request.header.custom-header=false"
```
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[PutMethod](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/put-method.html)*中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def add_integration_method(
self,
resource_id,
rest_method,
service_endpoint_prefix,
service_action,
service_method,
role_arn,
mapping_template,
):
"""
Adds an integration method to a REST API. An integration method is a REST
resource, such as '/users', and an HTTP verb, such as GET. The integration
method is backed by an AWS service, such as Amazon DynamoDB.
:param resource_id: The ID of the REST resource.
:param rest_method: The HTTP verb used with the REST resource.
:param service_endpoint_prefix: The service endpoint that is integrated with
this method, such as 'dynamodb'.
:param service_action: The action that is called on the service, such as
'GetItem'.
:param service_method: The HTTP method of the service request, such as POST.
:param role_arn: The Amazon Resource Name (ARN) of a role that grants API
Gateway permission to use the specified action with the
service.
:param mapping_template: A mapping template that is used to translate REST
elements, such as query parameters, to the request
body format required by the service.
"""
service_uri = (
f"arn:aws:apigateway:{self.apig_client.meta.region_name}"
f":{service_endpoint_prefix}:action/{service_action}"
)
try:
self.apig_client.put_method(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
authorizationType="NONE",
)
self.apig_client.put_method_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseModels={"application/json": "Empty"},
)
logger.info("Created %s method for resource %s.", rest_method, resource_id)
except ClientError:
logger.exception(
"Couldn't create %s method for resource %s.", rest_method, resource_id
)
raise
try:
self.apig_client.put_integration(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
type="AWS",
integrationHttpMethod=service_method,
credentials=role_arn,
requestTemplates={"application/json": json.dumps(mapping_template)},
uri=service_uri,
passthroughBehavior="WHEN_NO_TEMPLATES",
)
self.apig_client.put_integration_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseTemplates={"application/json": ""},
)
logger.info(
"Created integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
except ClientError:
logger.exception(
"Couldn't create integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
raise
```
+ 有关 API 的详细信息，请参阅适用[PutMethod](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutMethod)于 *Python 的AWS SDK (Boto3) API 参考*。
------
#### [ SAP ABAP ]
**适用于 SAP ABAP 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples)中查找完整示例，了解如何进行设置和运行。
```
TRY.
oo_result = lo_agw->putmethod(
iv_restapiid = iv_rest_api_id
iv_resourceid = iv_resource_id
iv_httpmethod = iv_http_method
iv_authorizationtype = 'NONE' ).
MESSAGE 'Method ' && iv_http_method && ' added to resource' TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwnotfoundexception INTO DATA(lo_not_found).
MESSAGE lo_not_found->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
ENDTRY.
```
+ 有关 API 的详细信息，请参阅适用[PutMethod](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)于 S *AP 的AWS SDK ABAP API 参考*。
------
# `PutMethodResponse`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `PutMethodResponse`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [创建并部署 REST API](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
------
#### [ CLI ]
**AWS CLI**
**基于指定状态代码，通过自定义方法响应标头创建方法响应**
命令:
```
aws apigateway put-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 400 --response-parameters "method.response.header.custom-header=false"
```
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[PutMethodResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/put-method-response.html)*中的。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples)中查找完整示例，了解如何进行设置和运行。
```
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def add_integration_method(
self,
resource_id,
rest_method,
service_endpoint_prefix,
service_action,
service_method,
role_arn,
mapping_template,
):
"""
Adds an integration method to a REST API. An integration method is a REST
resource, such as '/users', and an HTTP verb, such as GET. The integration
method is backed by an AWS service, such as Amazon DynamoDB.
:param resource_id: The ID of the REST resource.
:param rest_method: The HTTP verb used with the REST resource.
:param service_endpoint_prefix: The service endpoint that is integrated with
this method, such as 'dynamodb'.
:param service_action: The action that is called on the service, such as
'GetItem'.
:param service_method: The HTTP method of the service request, such as POST.
:param role_arn: The Amazon Resource Name (ARN) of a role that grants API
Gateway permission to use the specified action with the
service.
:param mapping_template: A mapping template that is used to translate REST
elements, such as query parameters, to the request
body format required by the service.
"""
service_uri = (
f"arn:aws:apigateway:{self.apig_client.meta.region_name}"
f":{service_endpoint_prefix}:action/{service_action}"
)
try:
self.apig_client.put_method(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
authorizationType="NONE",
)
self.apig_client.put_method_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseModels={"application/json": "Empty"},
)
logger.info("Created %s method for resource %s.", rest_method, resource_id)
except ClientError:
logger.exception(
"Couldn't create %s method for resource %s.", rest_method, resource_id
)
raise
try:
self.apig_client.put_integration(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
type="AWS",
integrationHttpMethod=service_method,
credentials=role_arn,
requestTemplates={"application/json": json.dumps(mapping_template)},
uri=service_uri,
passthroughBehavior="WHEN_NO_TEMPLATES",
)
self.apig_client.put_integration_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseTemplates={"application/json": ""},
)
logger.info(
"Created integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
except ClientError:
logger.exception(
"Couldn't create integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
raise
```
+ 有关 API 的详细信息，请参阅适用[PutMethodResponse](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutMethodResponse)于 *Python 的AWS SDK (Boto3) API 参考*。
------
#### [ SAP ABAP ]
**适用于 SAP ABAP 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/agw#code-examples)中查找完整示例，了解如何进行设置和运行。
```
TRY.
oo_result = lo_agw->putmethodresponse(
iv_restapiid = iv_rest_api_id
iv_resourceid = iv_resource_id
iv_httpmethod = iv_http_method
iv_statuscode = '200' ).
MESSAGE 'Method response configured for status 200' TYPE 'I'.
CATCH /aws1/cx_agwbadrequestex INTO DATA(lo_bad_request).
MESSAGE lo_bad_request->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request.
CATCH /aws1/cx_agwnotfoundexception INTO DATA(lo_not_found).
MESSAGE lo_not_found->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found.
CATCH /aws1/cx_agwtoomanyrequestsex INTO DATA(lo_too_many).
MESSAGE lo_too_many->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many.
ENDTRY.
```
+ 有关 API 的详细信息，请参阅适用[PutMethodResponse](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)于 S *AP 的AWS SDK ABAP API 参考*。
------
# `UpdateBasePathMapping`与 AWS SDK 或 CLI 配合使用
以下代码示例演示如何使用 `UpdateBasePathMapping`。
------
#### [ CLI ]
**AWS CLI**
**更改自定义域名的基础路径**
命令:
```
aws apigateway update-base-path-mapping --domain-name api.domain.tld --base-path prod --patch-operations op='replace',path='/basePath',value='v1'
```
输出：
```
{
"basePath": "v1",
"restApiId": "1234123412",
"stage": "api"
}
```
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[UpdateBasePathMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-base-path-mapping.html)*中的。
------
#### [ PHP ]
**适用于 PHP 的 SDK**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/apigateway#code-examples)中查找完整示例，了解如何进行设置和运行。
```
require 'vendor/autoload.php';
use Aws\ApiGateway\ApiGatewayClient;
use Aws\Exception\AwsException;
/* ////////////////////////////////////////////////////////////////////////////
*
* Purpose: Updates the base path mapping for a custom domain name
* in Amazon API Gateway.
*
* Inputs:
* - $apiGatewayClient: An initialized AWS SDK for PHP API client for
* API Gateway.
* - $basePath: The base path name that callers must provide as part of the
* URL after the domain name.
* - $domainName: The custom domain name for the base path mapping.
* - $patchOperations: The base path update operations to apply.
*
* Returns: Information about the updated base path mapping, if available;
* otherwise, the error message.
* ///////////////////////////////////////////////////////////////////////// */
function updateBasePathMapping(
$apiGatewayClient,
$basePath,
$domainName,
$patchOperations
) {
try {
$result = $apiGatewayClient->updateBasePathMapping([
'basePath' => $basePath,
'domainName' => $domainName,
'patchOperations' => $patchOperations
]);
return 'The updated base path\'s URI is: ' .
$result['@metadata']['effectiveUri'];
} catch (AwsException $e) {
return 'Error: ' . $e['message'];
}
}
function updateTheBasePathMapping()
{
$patchOperations = array([
'op' => 'replace',
'path' => '/stage',
'value' => 'stage2'
]);
$apiGatewayClient = new ApiGatewayClient([
'profile' => 'default',
'region' => 'us-east-1',
'version' => '2015-07-09'
]);
echo updateBasePathMapping(
$apiGatewayClient,
'(none)',
'example.com',
$patchOperations
);
}
// Uncomment the following line to run this code in an AWS account.
// updateTheBasePathMapping();
```
+ 有关 API 的详细信息，请参阅 *适用于 PHP 的 AWS SDK API 参考[UpdateBasePathMapping](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateBasePathMapping)*中的。
------
# API Gateway 使用的场景 AWS SDKs
以下代码示例向您展示了如何在 API Gateway 中使用实现常见场景 AWS SDKs。这些场景向您展示了如何通过调用 API Gateway 中的多个函数或与其他 AWS 服务结合来完成特定任务。每个场景都包含完整源代码的链接，您可以在其中找到有关如何设置和运行代码的说明。
场景以中等水平的经验为目标，可帮助您结合具体环境了解服务操作。
**Topics**
+ [创建 REST API 以跟踪 COVID-19 数据](api-gateway_example_cross_ApiGatewayDataTracker_section.md)
+ [创建借阅图书馆 REST API](api-gateway_example_cross_AuroraRestLendingLibrary_section.md)
+ [创建无服务器应用程序来管理照片](api-gateway_example_cross_PAM_section.md)
+ [创建 Websocket 聊天应用程序](api-gateway_example_cross_ApiGatewayWebsocketChat_section.md)
+ [创建并部署 REST API](api-gateway_example_api-gateway_Usage_CreateDeployRest_section.md)
+ [使用 API Gateway 调用 Lambda 函数](api-gateway_example_cross_LambdaAPIGateway_section.md)
# 创建 API Gateway REST API 以跟踪 COVID-19 数据
以下代码示例显示如何创建 REST API，该 API 模拟一个使用虚构数据跟踪美国每日 COVID-19 病例的系统。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
演示如何使用 AWS Chalice 和 适用于 Python (Boto3) 的 AWS SDK 来创建使用亚马逊 API Gateway 和 Amazon DynamoDB 的无服务器 REST API。 AWS Lambda REST API 模拟一个使用虚构数据跟踪美国每日 COVID-19 病例的系统。了解如何：
+ 使用 AWS Chalice 在 Lambda 函数中定义路由，这些函数用于处理通过 API Gateway 发出的 REST 请求。
+ 使用 Lambda 函数在 DynamoDB 表中检索数据并存储数据以处理 REST 请求。
+ 在 AWS CloudFormation 模板中定义表结构和安全角色资源。
+ 使用 AWS Chalice and CloudFormation 来打包和部署所有必要的资源。
+ CloudFormation 用于清理所有已创建的资源。
有关如何设置和运行的完整源代码和说明，请参阅上的完整示例[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/cross_service/apigateway_covid-19_tracker)。
**本示例中使用的服务**
+ API Gateway
+ CloudFormation
+ DynamoDB
+ Lambda
------
# 创建借阅图书馆 REST API
以下代码示例显示如何创建借阅图书馆，其中顾客可以使用由 Amazon Aurora 数据库支持的 REST API 借阅和归还图书。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
演示如何使用 适用于 Python (Boto3) 的 AWS SDK 与亚马逊关系数据库服务 (Amazon RDS) API 和 AWS Chalice 一起创建由亚马逊 Aurora 数据库支持的 REST API。此 Web 服务是完全无服务器的，代表简单的借阅图书馆，其中顾客可以借阅和归还图书。了解如何：
+ 创建和管理无服务器 Aurora 数据库集群。
+ AWS Secrets Manager 用于管理数据库凭证。
+ 实施一个数据存储层，该层使用 Amazon RDS 将数据移入和移出数据库。
+ 使用 AWS Chalice 将无服务器 REST API 部署到亚马逊 API Gateway 和。 AWS Lambda
+ 使用请求软件包向 Web 服务发送请求。
有关如何设置和运行的完整源代码和说明，请参阅上的完整示例[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/cross_service/aurora_rest_lending_library)。
**本示例中使用的服务**
+ API Gateway
+ Aurora
+ Lambda
+ Secrets Manager
------
# 创建照片资产管理应用程序，让用户能够使用标签管理照片
以下代码示例演示了如何创建无服务器应用程序，让用户能够使用标签管理照片。
------
#### [ .NET ]
**适用于 .NET 的 SDK**
演示如何开发照片资产管理应用程序，该应用程序使用 Amazon Rekognition 检测图像中的标签并将其存储以供日后检索。
有关如何设置和运行的完整源代码和说明，请参阅上的完整示例[ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/cross-service/PhotoAssetManager)。
要深入了解这个例子的起源，请参阅 [AWS 社区](https://community.aws/posts/cloud-journeys/01-serverless-image-recognition-app)上的博文。
**本示例中使用的服务**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon Rekognition
+ Amazon S3
+ Amazon SNS
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
演示如何开发照片资产管理应用程序，该应用程序使用 Amazon Rekognition 检测图像中的标签并将其存储以供日后检索。
有关如何设置和运行的完整源代码和说明，请参阅上的完整示例[ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/cross-service/photo_asset_manager)。
要深入了解这个例子的起源，请参阅 [AWS 社区](https://community.aws/posts/cloud-journeys/01-serverless-image-recognition-app)上的博文。
**本示例中使用的服务**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon Rekognition
+ Amazon S3
+ Amazon SNS
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
演示如何开发照片资产管理应用程序，该应用程序使用 Amazon Rekognition 检测图像中的标签并将其存储以供日后检索。
有关如何设置和运行的完整源代码和说明，请参阅上的完整示例[ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/usecases/pam_source_files)。
要深入了解这个例子的起源，请参阅 [AWS 社区](https://community.aws/posts/cloud-journeys/01-serverless-image-recognition-app)上的博文。
**本示例中使用的服务**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon Rekognition
+ Amazon S3
+ Amazon SNS
------
#### [ JavaScript ]
**适用于 JavaScript (v3) 的软件开发工具包**
演示如何开发照片资产管理应用程序，该应用程序使用 Amazon Rekognition 检测图像中的标签并将其存储以供日后检索。
有关如何设置和运行的完整源代码和说明，请参阅上的完整示例[ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/photo-asset-manager)。
要深入了解这个例子的起源，请参阅 [AWS 社区](https://community.aws/posts/cloud-journeys/01-serverless-image-recognition-app)上的博文。
**本示例中使用的服务**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon Rekognition
+ Amazon S3
+ Amazon SNS
------
#### [ Kotlin ]
**适用于 Kotlin 的 SDK**
演示如何开发照片资产管理应用程序，该应用程序使用 Amazon Rekognition 检测图像中的标签并将其存储以供日后检索。
有关如何设置和运行的完整源代码和说明，请参阅上的完整示例[ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/usecases/creating_pam)。
要深入了解这个例子的起源，请参阅 [AWS 社区](https://community.aws/posts/cloud-journeys/01-serverless-image-recognition-app)上的博文。
**本示例中使用的服务**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon Rekognition
+ Amazon S3
+ Amazon SNS
------
#### [ PHP ]
**适用于 PHP 的 SDK**
演示如何开发照片资产管理应用程序，该应用程序使用 Amazon Rekognition 检测图像中的标签并将其存储以供日后检索。
有关如何设置和运行的完整源代码和说明，请参阅上的完整示例[ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/applications/photo_asset_manager)。
要深入了解这个例子的起源，请参阅 [AWS 社区](https://community.aws/posts/cloud-journeys/01-serverless-image-recognition-app)上的博文。
**本示例中使用的服务**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon Rekognition
+ Amazon S3
+ Amazon SNS
------
#### [ Rust ]
**适用于 Rust 的 SDK**
演示如何开发照片资产管理应用程序，该应用程序使用 Amazon Rekognition 检测图像中的标签并将其存储以供日后检索。
有关如何设置和运行的完整源代码和说明，请参阅上的完整示例[ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/cross_service/photo_asset_management)。
要深入了解这个例子的起源，请参阅 [AWS 社区](https://community.aws/posts/cloud-journeys/01-serverless-image-recognition-app)上的博文。
**本示例中使用的服务**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon Rekognition
+ Amazon S3
+ Amazon SNS
------
# 使用 API Gateway 创建 Websocket 聊天应用程序
以下代码示例显示如何创建由基于 Amazon API Gateway 构建的 Websocket API 提供服务的聊天应用程序。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
演示如何在 Amazon API Gateway V2 中使用来创建 适用于 Python (Boto3) 的 AWS SDK 与亚马逊 DynamoDB 集成的 websocket API。 AWS Lambda
+ 创建由 API Gateway 提供服务的 Websocket API。
+ 定义在 DynamoDB 中存储连接并向其他聊天参与者发布消息的 Lambda 处理程序。
+ 连接到 Websocket 聊天应用程序并使用 WebSocket 软件包发送消息。
有关如何设置和运行的完整源代码和说明，请参阅上的完整示例[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/cross_service/apigateway_websocket_chat)。
**本示例中使用的服务**
+ API Gateway
+ DynamoDB
+ Lambda
------
# 使用 AWS 软件开发工具包创建和部署 REST API
以下代码示例展示了如何：
+ 创建由 API Gateway 提供服务的 REST API。
+ 向 REST API 添加资源以表示用户配置文件。
+ 添加集成方法，以便 REST API 使用 DynamoDB 表存储用户配置文件数据。
+ 向 REST API 发送 HTTP 请求以添加和检索用户配置文件。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/api-gateway#code-examples)中查找完整示例，了解如何进行设置和运行。
创建一个包装 API Gateway 操作的类。
```
import argparse
import json
import logging
from pprint import pprint
import boto3
from botocore.exceptions import ClientError
import requests
logger = logging.getLogger(__name__)
class ApiGatewayToService:
"""
Encapsulates Amazon API Gateway functions that are used to create a REST API that
integrates with another AWS service.
"""
def __init__(self, apig_client):
"""
:param apig_client: A Boto3 API Gateway client.
"""
self.apig_client = apig_client
self.api_id = None
self.root_id = None
self.stage = None
def create_rest_api(self, api_name):
"""
Creates a REST API on API Gateway. The default API has only a root resource
and no HTTP methods.
:param api_name: The name of the API. This descriptive name is not used in
the API path.
:return: The ID of the newly created API.
"""
try:
result = self.apig_client.create_rest_api(name=api_name)
self.api_id = result["id"]
logger.info("Created REST API %s with ID %s.", api_name, self.api_id)
except ClientError:
logger.exception("Couldn't create REST API %s.", api_name)
raise
try:
result = self.apig_client.get_resources(restApiId=self.api_id)
self.root_id = next(
item for item in result["items"] if item["path"] == "/"
)["id"]
except ClientError:
logger.exception("Couldn't get resources for API %s.", self.api_id)
raise
except StopIteration as err:
logger.exception("No root resource found in API %s.", self.api_id)
raise ValueError from err
return self.api_id
def add_rest_resource(self, parent_id, resource_path):
"""
Adds a resource to a REST API.
:param parent_id: The ID of the parent resource.
:param resource_path: The path of the new resource, relative to the parent.
:return: The ID of the new resource.
"""
try:
result = self.apig_client.create_resource(
restApiId=self.api_id, parentId=parent_id, pathPart=resource_path
)
resource_id = result["id"]
logger.info("Created resource %s.", resource_path)
except ClientError:
logger.exception("Couldn't create resource %s.", resource_path)
raise
else:
return resource_id
def add_integration_method(
self,
resource_id,
rest_method,
service_endpoint_prefix,
service_action,
service_method,
role_arn,
mapping_template,
):
"""
Adds an integration method to a REST API. An integration method is a REST
resource, such as '/users', and an HTTP verb, such as GET. The integration
method is backed by an AWS service, such as Amazon DynamoDB.
:param resource_id: The ID of the REST resource.
:param rest_method: The HTTP verb used with the REST resource.
:param service_endpoint_prefix: The service endpoint that is integrated with
this method, such as 'dynamodb'.
:param service_action: The action that is called on the service, such as
'GetItem'.
:param service_method: The HTTP method of the service request, such as POST.
:param role_arn: The Amazon Resource Name (ARN) of a role that grants API
Gateway permission to use the specified action with the
service.
:param mapping_template: A mapping template that is used to translate REST
elements, such as query parameters, to the request
body format required by the service.
"""
service_uri = (
f"arn:aws:apigateway:{self.apig_client.meta.region_name}"
f":{service_endpoint_prefix}:action/{service_action}"
)
try:
self.apig_client.put_method(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
authorizationType="NONE",
)
self.apig_client.put_method_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseModels={"application/json": "Empty"},
)
logger.info("Created %s method for resource %s.", rest_method, resource_id)
except ClientError:
logger.exception(
"Couldn't create %s method for resource %s.", rest_method, resource_id
)
raise
try:
self.apig_client.put_integration(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
type="AWS",
integrationHttpMethod=service_method,
credentials=role_arn,
requestTemplates={"application/json": json.dumps(mapping_template)},
uri=service_uri,
passthroughBehavior="WHEN_NO_TEMPLATES",
)
self.apig_client.put_integration_response(
restApiId=self.api_id,
resourceId=resource_id,
httpMethod=rest_method,
statusCode="200",
responseTemplates={"application/json": ""},
)
logger.info(
"Created integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
except ClientError:
logger.exception(
"Couldn't create integration for resource %s to service URI %s.",
resource_id,
service_uri,
)
raise
def deploy_api(self, stage_name):
"""
Deploys a REST API. After a REST API is deployed, it can be called from any
REST client, such as the Python Requests package or Postman.
:param stage_name: The stage of the API to deploy, such as 'test'.
:return: The base URL of the deployed REST API.
"""
try:
self.apig_client.create_deployment(
restApiId=self.api_id, stageName=stage_name
)
self.stage = stage_name
logger.info("Deployed stage %s.", stage_name)
except ClientError:
logger.exception("Couldn't deploy stage %s.", stage_name)
raise
else:
return self.api_url()
def api_url(self, resource=None):
"""
Builds the REST API URL from its parts.
:param resource: The resource path to append to the base URL.
:return: The REST URL to the specified resource.
"""
url = (
f"https://{self.api_id}.execute-api.{self.apig_client.meta.region_name}"
f".amazonaws.com/{self.stage}"
)
if resource is not None:
url = f"{url}/{resource}"
return url
```
部署 REST API 并使用请求包调用它。
```
def usage_demo(table_name, role_name, rest_api_name):
"""
Demonstrates how to used API Gateway to create and deploy a REST API, and how
to use the Requests package to call it.
:param table_name: The name of the demo DynamoDB table.
:param role_name: The name of the demo role that grants API Gateway permission to
call DynamoDB.
:param rest_api_name: The name of the demo REST API created by the demo.
"""
gateway = ApiGatewayToService(boto3.client("apigateway"))
role = boto3.resource("iam").Role(role_name)
print("Creating REST API in API Gateway.")
gateway.create_rest_api(rest_api_name)
print("Adding resources to the REST API.")
profiles_id = gateway.add_rest_resource(gateway.root_id, "profiles")
username_id = gateway.add_rest_resource(profiles_id, "{username}")
# The DynamoDB service requires that all integration requests use POST.
print("Adding integration methods to read and write profiles in Amazon DynamoDB.")
gateway.add_integration_method(
profiles_id,
"GET",
"dynamodb",
"Scan",
"POST",
role.arn,
{"TableName": table_name},
)
gateway.add_integration_method(
profiles_id,
"POST",
"dynamodb",
"PutItem",
"POST",
role.arn,
{
"TableName": table_name,
"Item": {
"username": {"S": "$input.path('$.username')"},
"name": {"S": "$input.path('$.name')"},
"title": {"S": "$input.path('$.title')"},
},
},
)
gateway.add_integration_method(
username_id,
"GET",
"dynamodb",
"GetItem",
"POST",
role.arn,
{
"TableName": table_name,
"Key": {"username": {"S": "$method.request.path.username"}},
},
)
stage = "test"
print(f"Deploying the {stage} stage.")
gateway.deploy_api(stage)
profiles_url = gateway.api_url("profiles")
print(
f"Using the Requests package to post some people to the profiles REST API at "
f"{profiles_url}."
)
requests.post(
profiles_url,
json={"username": "will", "name": "William Shakespeare", "title": "playwright"},
)
requests.post(
profiles_url,
json={
"username": "ludwig",
"name": "Ludwig van Beethoven",
"title": "composer",
},
)
requests.post(
profiles_url,
json={"username": "jane", "name": "Jane Austen", "title": "author"},
)
print("Getting the list of profiles from the REST API.")
profiles = requests.get(profiles_url).json()
pprint(profiles)
print(f"Getting just the profile for username 'jane' (URL: {profiles_url}/jane).")
jane = requests.get(f"{profiles_url}/jane").json()
pprint(jane)
```
+ 有关 API 详细信息，请参阅《AWS SDK for Python (Boto3) API Reference》**中的以下主题。
+ [CreateDeployment](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateDeployment)
+ [CreateResource](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateResource)
+ [CreateRestApi](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateRestApi)
+ [DeleteRestApi](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteRestApi)
+ [GetResources](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetResources)
+ [GetRestApis](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetRestApis)
+ [PutIntegration](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutIntegration)
+ [PutIntegrationResponse](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutIntegrationResponse)
+ [PutMethod](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutMethod)
+ [PutMethodResponse](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutMethodResponse)
------
# 使用 API Gateway 调用 Lambda 函数
以下代码示例展示了如何创建由 Amazon API Gateway 调用的 AWS Lambda 函数。
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
演示如何使用 Lambda Java 运行时 API 创建 AWS Lambda 函数。此示例调用不同的 AWS 服务来执行特定的用例。此示例展示了如何创建通过 Amazon API Gateway 调用的 Lambda 函数，该函数扫描 Amazon DynamoDB 表获取工作周年纪念日，并使用 Amazon Simple Notification Service (Amazon SNS)向员工发送文本消息，祝贺他们的周年纪念日。
有关如何设置和运行的完整源代码和说明，请参阅上的完整示例[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/usecases/creating_lambda_apigateway)。
**本示例中使用的服务**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon SNS
------
#### [ JavaScript ]
**适用于 JavaScript (v3) 的软件开发工具包**
演示如何使用 Lambda JavaScript 运行时 API 创建 AWS Lambda 函数。此示例调用不同的 AWS 服务来执行特定的用例。此示例展示了如何创建通过 Amazon API Gateway 调用的 Lambda 函数，该函数扫描 Amazon DynamoDB 表获取工作周年纪念日，并使用 Amazon Simple Notification Service (Amazon SNS)向员工发送文本消息，祝贺他们的周年纪念日。
有关如何设置和运行的完整源代码和说明，请参阅上的完整示例[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/lambda-api-gateway)。
该示例也可在 [适用于 JavaScript 的 AWS SDK v3 开发人员指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/api-gateway-invoking-lambda-example.html)中找到。
**本示例中使用的服务**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon SNS
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
此示例显示如何创建和使用以 AWS Lambda 函数为目标的 Amazon API Gateway REST API。Lambda 处理程序演示了如何基于 HTTP 方法进行路由；如何从查询字符串、标头和正文中获取数据；以及如何返回 JSON 响应。
+ 部署 Lambda 函数。
+ 使用 API Gateway 创建 REST API
+ 创建以 Lambda 函数为目标的 REST 资源。
+ 授予允许 API Gateway 调用 Lambda 函数的权限。
+ 使用请求软件包向 REST API 发送请求。
+ 清理演示期间创建的所有资源。
最好在上查看此示例 GitHub。有关如何设置和运行的完整源代码和说明，请参阅上的完整示例[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/lambda#readme)。
**本示例中使用的服务**
+ API Gateway
+ DynamoDB
+ Lambda
+ Amazon SNS
------
# AWS API Gateway 的社区贡献
*AWS 社区贡献*就是由多个团队创建和维护的示例 AWS。要提供反馈，请使用链接存储库中提供的机制。
**Topics**
+ [构建和测试无服务器应用程序](api-gateway_example_tributary-lite_serverless-application_section.md)
# 构建和测试无服务器应用程序
以下代码示例演示如何使用 API Gateway 与 Lambda 和 DynamoDB 构建和测试无服务器应用程序
------
#### [ .NET ]
**适用于 .NET 的 SDK**
演示如何使用 .NET SDK 构建和测试包含 API Gateway 以及 Lambda 和 DynamoDB 的无服务器应用程序。
有关如何设置和运行的完整源代码和说明，请参阅上的完整示例[GitHub](https://github.com/aws-samples/serverless-dotnet-demo)。
**本示例中使用的服务**
+ API Gateway
+ DynamoDB
+ Lambda
------
#### [ Go ]
**适用于 Go 的 SDK V2**
演示如何使用 Go SDK 构建和测试包含 API Gateway 以及 Lambda 和 DynamoDB 的无服务器应用程序。
有关如何设置和运行的完整源代码和说明，请参阅上的完整示例[GitHub](https://github.com/aws-samples/serverless-go-demo)。
**本示例中使用的服务**
+ API Gateway
+ DynamoDB
+ Lambda
------
#### [ Java ]
**适用于 Java 的 SDK 2.x**
演示如何使用 Java SDK 构建和测试包含 API Gateway 以及 Lambda 和 DynamoDB 的无服务器应用程序。
有关如何设置和运行的完整源代码和说明，请参阅上的完整示例[GitHub](https://github.com/aws-samples/serverless-java-frameworks-samples)。
**本示例中使用的服务**
+ API Gateway
+ DynamoDB
+ Lambda
------
#### [ Rust ]
**适用于 Rust 的 SDK**
演示如何使用 Rust SDK 构建和测试包含 API Gateway 以及 Lambda 和 DynamoDB 的无服务器应用程序。
有关如何设置和运行的完整源代码和说明，请参阅上的完整示例[GitHub](https://github.com/aws-samples/serverless-rust-demo)。
**本示例中使用的服务**
+ API Gateway
+ DynamoDB
+ Lambda
------