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

在 Amazon API Gateway 中调用 REST API

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

REST API 的基本 URL 采用以下格式:

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

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

重要

在可以调用 API 之前,必须将其部署在 API Gateway 中。为此,请遵循在 Amazon API Gateway 中部署 REST API中的说明。

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

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

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

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

注意

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