在门户中为 API Gateway 产品 REST 端点启用“试用”功能 - Amazon API Gateway
注意事项为产品 REST 端点启用“试用”功能

在门户中为 API Gateway 产品 REST 端点启用“试用”功能

使用“试用”功能让 API 使用者从您的门户调用您的产品端点。当 API 使用者使用“试用”功能时，他们会输入方法请求参数并调用您的产品端点。然后，API Gateway 通过公共互联网调用您的 API，并在试用窗口中返回响应。您可以使用自定义产品页面来提供有关访问您的 API 所需参数的任何其他信息。

API Gateway 使用以下限制来保护您的 API：

  • API Gateway 每秒只允许向您的 API 发出 3 个请求。

  • API Gateway 使用 29000 毫秒的内置超时限制。您的实际 API 可能有更高的超时限制，但是当客户使用“试用”功能时，API Gateway 不会应用此超时。

  • API Gateway 将响应有效载荷限制在 6 MB 以内。

注意事项

以下注意事项可能会影响您使用“试用”功能的方式：

  • 在预览门户时不支持“试用”功能。

  • 具有以下功能的 REST API 不支持“试用”功能：

    • 私有 API

    • 使用双向 TLS 的 API

    • 使用私有或自签名 SSL 证书的 API

    作为门户所有者，对于任何不支持的 REST API，您有责任向 API 使用者说明“试用”按钮未显示的原因。API Gateway 不会为您解释这一点。

为产品 REST 端点启用“试用”功能

以下步骤展示了如何对产品端点启用“试用”功能。

要了解如何在门户中使用“试用”功能，请参阅使用 API Gateway 门户。

为产品 REST 端点启用“试用”功能

  1. 在主导航窗格中，选择门户产品。

  2. 选择产品。

  3. 在文档选项卡的 API 参考页面下，选择产品 REST 端点的名称，例如 /dogs - GET。

  4. 选择编辑页面。

  5. 要允许客户在您的门户中调用您的 API，请选择“试用”功能。

  6. 选择保存更改。

  7. 您必须重新发布所有使用此门户产品的门户，更改才能生效。