Amazon API Gateway

开发人员指南

AWS 文档 » Amazon API Gateway » 开发人员指南 » 在 Amazon API Gateway 中创建、部署和调用 REST API » 在 Amazon API Gateway 中创建 REST API » 在 API Gateway 中初始化 REST API 设置 » 在 API Gateway 中设置区域 API

在 API Gateway 中设置区域 API

当 API 请求主要来自与 API 部署到的相同区域中的 EC2 实例或服务时，使用区域 API 终端节点通常可以降低连接的延迟，推荐用于此类场景。

要创建区域 API，您可以按照创建边缘优化的 API 中的步骤操作，但必须明确将 REGIONAL 类型设置为 API 的 endpointConfiguration 的唯一选项。

在下文中，我们演示如何使用 API Gateway 控制台、AWS CLI、适用于 Javascript for Node.js 的 AWS 开发工具包创建区域 API。

使用 API Gateway 控制台创建区域 API

使用 API Gateway 控制台创建区域 API

1. 登录到 API Gateway 控制台，然后选择 + Create API (+ 创建 API)。

2. 在 Create new API (创建新 API) 下，选择 New API (新建 API) 选项。

3. 为 API name (API 名称) 键入名称（例如，Simple PetStore (Console, Regional)）。

4. 为 Endpoint Type (终端节点类型) 选择 Regional。

5. 选择 Create API (创建 API)。

从这里开始，您可以继续设置 API 方法及其关联的集成，如创建边缘优化的 API 中所述。

使用 AWS CLI 创建区域 API

要使用 AWS CLI 创建区域 API，请调用 create-rest-api 命令：

aws apigateway create-rest-api \
        --name 'Simple PetStore (AWS CLI, Regional)' \
        --description 'Simple regional PetStore API' \
        --region us-west-2 \
        --endpoint-configuration '{ "types": ["REGIONAL"] }'

成功的响应返回与以下类似的负载：

{
    "createdDate": "2017-10-13T18:41:39Z",
    "description": "Simple regional PetStore API",
    "endpointConfiguration": {
        "types": "REGIONAL"
    },
    "id": "0qzs2sy7bh",
    "name": "Simple PetStore (AWS CLI, Regional)"
}

从这里开始，您可以按照使用 AWS CLI 命令设置边缘优化的 API中提供的相同说明来为此 API 设置方法和集成。

使用适用于 JavaScript 的 AWS 开发工具包创建区域 API

使用适用于 JavaScript 的 AWS 开发工具包创建区域 API：

apig.createRestApi({
	name: "Simple PetStore (node.js SDK, regional)",
	endpointConfiguration: {
		types: ['REGIONAL']
	},
	description: "Demo regional API created using the AWS SDK for node.js",
	version: "0.00.001"
}, function(err, data){
	if (!err) {
		console.log('Create API succeeded:\n', data);
		restApiId = data.id;
	} else {
		console.log('Create API failed:\n', err);
	}
});

成功的响应返回与以下类似的负载：

{
    "createdDate": "2017-10-13T18:41:39Z",
    "description": "Demo regional API created using the AWS SDK for node.js",
    "endpointConfiguration": {
        "types": "REGIONAL"
    },
    "id": "0qzs2sy7bh",
    "name": "Simple PetStore (node.js SDK, regional)"
}

完成前面的步骤之后，您可以按照使用适用于 Node.js 的 AWS 开发工具包设置边缘优化的 API中的说明来为此 API 设置方法和集成。

测试区域 API

在部署后，区域 API 的默认 URL 主机名为以下格式：

{restapi-id}.execute-api.{region}.amazonaws.com

用于调用 API 的基本 URL 与以下类似：

https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}

假定您在本示例中设置 GET /pets 和 GET /pets/{petId} 方法，您可以通过在浏览器中键入以下 URL 来测试 API：

https://0qzs2sy7bh.execute-api.us-west-2.amazonaws.com/test/pets

和

https://0qzs2sy7bh.execute-api.us-west-2.amazonaws.com/test/pets/1

或者，您可以使用 cURL 命令：

curl -X GET https://0qzs2sy7bh.execute-api.us-west-2.amazonaws.com/test/pets 

和

curl -X GET https://0qzs2sy7bh.execute-api.us-west-2.amazonaws.com/test/pets/2

本页内容：

• 使用 API Gateway 控制台创建区域 API
• 使用 AWS CLI 创建区域 API
• 使用适用于 JavaScript 的 AWS 开发工具包创建区域 API
• 测试区域 API