使用 API Gateway 控制台测试 REST API 方法 - Amazon API Gateway
先决条件使用 API Gateway 控制台测试方法
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

使用 API Gateway 控制台测试 REST API 方法

使用 API Gateway 控制台测试 REST API 方法。

先决条件

使用 API Gateway 控制台测试方法

重要

使用 API Gateway 控制台测试方法可能会导致对资源进行无法撤销的更改。使用 API Gateway 控制台测试方法与在 API Gateway 控制台之外调用方法相同。例如，如果您使用 API Gateway 控制台调用用于删除 API 资源的方法，并且方法调用成功，那么将删除 API 资源。

Old REST API console
注意

我们重新设计了 API Gateway 控制台。从 2023 年 11 月下旬开始，旧的控制台体验将不再可用。

测试方法

  1. 通过以下网址登录到 Amazon API Gateway 控制台：https://console.aws.amazon.com/apigateway。

  2. 选择一个 REST API。

  3. 在资源窗格中，选择要测试的方法。

  4. 在 Method Execution (方法执行) 窗格中的 Client (客户端) 框中，选择 TEST。在任何显示的框中输入值（例如 Query Strings (查询字符串)、Headers (标头) 和 Request Body (响应正文)）。控制台会以默认 application/json 形式将这些值包括在方法请求中。

    对于您可能需要指定的其他选项，请联系 API 所有者。

  5. 选择 Test (测试)。此时将显示以下信息：

    • 请求是为方法调用的资源路径。

    • 状态是响应的 HTTP 状态代码。

    • 延迟是收到调用方请求和返回响应之间的时间。

    • 响应正文是 HTTP 响应正文。

    • 响应标头是 HTTP 响应标头。

      提示

      根据映射的不同，HTTP 状态代码、响应正文和响应标头可能不同于从 Lambda 函数、HTTP 代理或 Amazon 服务代理发送的内容。

    • 日志 是模拟的 Amazon CloudWatch Logs 条目，如果在 API Gateway 控制台之外调用此方法，则会写入这些条目。

      注意

      尽管 CloudWatch Logs 条目是模拟的，但方法调用的结果是真实的。

有关介绍控制台映像的其他教程，请参阅教程和研讨会部分中的教程：使用 HTTP 代理集成构建 REST API。

New REST API console
测试方法

  1. 通过以下网址登录到 Amazon API Gateway 控制台：https://console.aws.amazon.com/apigateway。

  2. 选择一个 REST API。

  3. 在资源窗格中，选择要测试的方法。

  4. 选择 Test（测试）选项卡。您可能需要选择右箭头按钮以显示该选项卡。

    在任何显示的框中输入值（例如查询字符串、标头和请求正文。控制台会以默认 application/json 形式将这些值包括在方法请求中。

    对于您可能需要指定的其它选项，请联系 API 所有者。

  5. 选择 Test (测试)。此时将显示以下信息：

    • 请求是为方法调用的资源路径。

    • 状态是响应的 HTTP 状态代码。

    • 延迟是收到调用方请求和返回响应之间的时间。

    • 响应正文是 HTTP 响应正文。

    • 响应标头是 HTTP 响应标头。

      提示

      根据映射的不同，HTTP 状态代码、响应正文和响应标头可能不同于从 Lambda 函数、HTTP 代理或 Amazon 服务代理发送的内容。

    • 日志显示模拟的 Amazon CloudWatch Logs 条目，如果在 API Gateway 控制台之外调用此方法，则会写入这些条目。

      注意

      尽管 CloudWatch Logs 条目是模拟的，但方法调用的结果是真实的。

除了使用 API Gateway 控制台之外，您还可以使用 Amazon CLI 或适用于 API Gateway 的 Amazon 开发工具包来测试调用方法。要使用 Amazon CLI 执行此操作，请参阅 test-invoke-method。