Amazon API Gateway
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 Amazon AWS 入门

调用 Amazon API Gateway 中的 API

调用已部署的 API 需要向 API Gateway 组件服务提交请求以完成 API 执行 (称为 execute-api)。此类请求的根 URL 的格式如下:

https://{restapi_id}.execute-api.{region}.amazonaws.com/{stage_name}/

其中 {restapi_id} 是 API 标识符,{region} 是已部署 API 的区域,{stage_name} 是某个 API 部署的阶段名称。

您可以在给定的 Stage Editor 中找到该根 URL。它将作为 Invoke URL 在顶部列出。如果 API 的根资源公开了一种无需用户身份验证的 GET 方法,您可以通过单击 Invoke URL 链接调用此方法。此外,您也可以构建此 URL,方法是组合已导出的 API Swagger 定义文件的 hostbasePath 字段。

如果某个 API 允许匿名访问,您可以使用任何 Web 浏览器复制相应的调用 URL 并将其粘贴到浏览器的地址栏中,以此来调用任何 GET 方法调用。对于其他方法或任何要求身份验证的调用,由于您必须指定负载或签署请求,该调用将更为复杂。您可以使用其中一个 AWS 开发工具包在 HTML 页面背后的脚本中或客户端应用程序中处理这些调用。

对于测试,您可以使用 API Gateway 的 TestInvoke 功能通过 API Gateway 控制台来调用 API,该功能可绕过调用 URL,允许在部署 API 之前进行 API 测试。或者,您也可以使用 Postman 应用程序来测试已成功部署的 API,无需编写脚本或客户端。

注意

调用 URL 中的查询字符串参数值不得包含 %%

您必须已经在 API Gateway 中部署了 API。按照在 Amazon API Gateway 中部署 API中的说明进行操作。

在 API Gateway 控制台中获取 API 的调用 URL

  1. 通过 https://console.amazonaws.cn/apigateway 登录 API Gateway 控制台。

  2. 在包含您要调用的 API 的名称的框中,选择 Stages

  3. Stages 窗格中,选择该阶段的名称。

  4. Invoke URL 旁显示的 URL 看起来应如下所示:其中 my-api-id 是 API Gateway 分配给您的 API 的标识符,region-id 是您在其中部署 API 的 AWS 区域标识符 (例如 us-east-1),stage-name 是您要调用的 API 的阶段名称:

    https://my-api-id.execute-api.region-id.amazonaws.com/stage-name/{resourcePath}

根据您要调用的方法类型和您要使用的工具,将此 URL 复制到剪贴板,然后粘贴并进行修改,以便从 Web 浏览器、Web 调试代理工具或 cURL 命令行工具,或您自己的 API 中调用 API。

如果您不熟悉要调用哪种方法或在调用时必须使用哪种格式,请遵循 在 API Gateway 中查看方法列表 中的说明浏览可用方法列表。

要直接从 API Gateway 控制台中调用方法,请参阅 使用控制台测试方法

有关更多选项,请联系 API 所有者。