# API Gateway 中的门户产品 **门户产品代表您要共享的服务或功能。门户产品是产品 REST 端点和产品页面的集合。**产品 REST 端点是门户产品的接入点，它们由 REST API 的路径和方法以及 REST API 部署到的阶段组成。**产品页面是您提供的文档，用于向 API 使用者说明如何使用您的产品端点。门户产品可以包含整个 `Prod` 阶段作为产品 REST 端点的集合，也可以仅包含作为单个产品 REST 端点部署到 `Prod` 阶段的 `GET /pets` 资源。 您的门户产品是可定制的。您可以添加自定义文档、重命名产品 REST 端点、重新组织显示顺序、添加新版块以及跨 AWS 账户共享产品。要使对门户产品所做的任何更改生效，您必须重新发布使用您的门户产品的所有门户。 ## 宠物领养门户产品示例 例如，您可以有多个代表宠物领养服务的 REST API。您可以使用 API Gateway 来创建 `pet adoption` 门户产品。该门户产品将帮助客户发现他们应该使用哪些 API 来见到和领养宠物。此门户产品使用您已经创建的 REST API，但它允许您重新分组和组织这些 API。您还可以提供有关使用宠物领养门户产品的条款和条件的文档，并让客户试用您的 API。这些信息全部存储在您的门户产品中。 下表显示了代表宠物领养门户产品的三个 API，以及它们对应的产品 REST 端点操作名称和页面版块名称。 | REST API ID | REST API 路径和方法 | REST API 阶段 | 操作名称 | 页面版块 | | --- | --- | --- | --- | --- | | kf5387miad | GET /dogs | Prod | View dogs | AdoptAnimals | | kf5387miad | GET /dogs/\$1dogId\$1 | Prod | View dog | AdoptAnimals | | ra8obxcevg | GET /cats | Prod | View cats | AdoptAnimals | | ra8obxcevg | GET /cats/\$1catId\$1 | Prod | View cat | AdoptAnimals | | h0rpx9cm62 | ANY /user/\$1userId\$1/\$1petId\$1\$1 | 测试版 | Request visit | AdoptProcess | 在此示例中，`ra8obxcevg` 和 `kf5387miad` 这两个 REST API 都归入 `AdoptAnimals` 版块。在门户中，此有序导航的结果将如下所示： ![\[宠物领养门户\]](http://docs.aws.amazon.com/zh_cn/apigateway/latest/developerguide/images/apigateway-portal.png) 由于 `ANY` 方法是一种万能方法，该门户会显示所有支持的 HTTP 方法。该门户还包含由门户产品所有者创建的文档。 ## 后续步骤 要开始使用门户产品，您可以执行以下操作： + 要创建门户产品，请参阅[在 API Gateway 中创建门户产品](apigateway-portals-create-portal-product.md)。 + 要了解“试用”功能，请参阅[在门户中为 API Gateway 产品 REST 端点启用“试用”功能](apigateway-portals-try-it.md)。 + 要了解产品页面，请参阅[在 API Gateway 中创建产品页面](apigateway-portals-create-product-page.md)。 + 要了解有关共享门户产品的信息，请参阅[在 API Gateway 中共享门户产品](apigateway-portals-share-resources.md)。 创建门户产品后，您可以将其发布到门户。有关更多信息，请参阅 [在 API Gateway 中创建门户](apigateway-portals-create-portal.md)。 # 在 API Gateway 中创建门户产品 以下过程说明了如何创建门户产品。门户是**门户产品的集合。创建门户产品后，您可以创建产品 REST 端点和产品页面。要了解有关门户产品的信息，请参阅 [API Gateway 中的门户产品](apigateway-portals-portal-product.md)。 ## 注意事项 以下注意事项可能会影响您创建门户产品的方式： + 您的门户产品可以包含私有和公共 REST API。试用功能不支持私有 API，因此您的门户在外观上会有所不同。作为门户所有者，您可能需要提供相关文档进行说明。 + 如果您使用 AWS CLI 或 AWS SDK 创建门户产品，则您的门户将没有任何产品端点或产品页面。您需要使用 AWS CLI 或控制台添加这些资源。要了解如何创建产品 REST 端点，请参阅[在 API Gateway 中创建产品 REST 端点](apigateway-portals-create-product-rest-endpoint.md)。要了解如何创建产品页面，请参阅[在 API Gateway 中创建产品页面](apigateway-portals-create-product-page.md)。 ## 创建门户产品 以下过程说明了如何创建门户产品。 **创建门户产品** 1. 通过以下网址登录到 Amazon API Gateway 控制台：[https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway)。 1. 在主导航窗格中，选择**门户产品**。 1. 选择**创建产品**。 1. 对于**产品名称**，输入您的门户产品的名称。 1. 对于**产品描述**，请输入描述。 1. 选择**下一步**。 1. 要选择您的产品 REST 端点，请在 **API 端点**下选择一个 API，然后选择一个阶段。 1. 要向您的产品 REST 端点添加端点，请选择 API 端点，然后选择**添加到产品**。 **注意** 在未先选择**添加到产品**之前，请勿选择**下一步**。 ![\[门户产品\]](http://docs.aws.amazon.com/zh_cn/apigateway/latest/developerguide/images/apigateway-portal-product.png) API 端点将显示在**选定 API 端点**列表中。 1. 选择**下一步**。 1. 检查您的选择，然后选择**创建产品**。 使用控制台创建门户产品后，您的所有产品页面和产品 REST 端点页面均为草稿，不会出现在门户中。要让消费者看到您的产品页面和产品 REST 端点页面，您需要将草稿添加到版块中。如果您使用 AWS CLI 或 AWS SDK 创建门户产品，则可以在 AWS CLI 命令中将草稿添加到版块中。无论您如何将草稿添加到版块中，都必须发布使用您的门户产品的门户，这样消费者才能看到您的产品。 **将草稿添加到页面版块** 1. 您的草稿将在**文档**选项卡中列出。您的产品页面有**草稿文档页面**，产品 REST 端点页面有**草稿 API 参考页面**。选择**草稿 API 参考页面**。 1. 选择草稿 API 参考页面。 如果您没有任何产品 REST 端点，则没有任何草稿 API 参考页面。要了解如何创建产品 REST 端点，请参阅[在 API Gateway 中创建产品 REST 端点](apigateway-portals-create-product-rest-endpoint.md)。 1. 选择**编辑页面**。 1. 在此页面上，您可以覆盖任何现有的 API 文档部分或使用 API Gateway 文档。要允许消费者看到您的产品 REST 端点页面的内容，请在**版块名称**下输入名称。如果这是 `/pets-GET` 端点，则页面名称可能是 `Pets`。 1. 选择**保存更改**。 1. 您创建的新页面名称将显示在 **API 参考页面**部分下。 要允许消费者看到新页面，您仍然需要重新发布您的门户。有关更多信息，请参阅 [在 API Gateway 中发布门户](apigateway-portals-publish-portal.md)。 # 在 API Gateway 中创建产品 REST 端点 产品 REST 端点是您的门户产品的接入点。每个端点都包含 REST API 的路径和方法以及 REST API 部署到的阶段。该端点包含您为 REST API 定义的所有文档，也可以使用自定义文档进行更新。创建产品 REST 端点时，需要配置以下设置： + 产品 REST 端点的操作名称。如果您的 REST API 具有路径和方法 `GET /pets`，则在门户中，名称为 `/pets`。使用操作名称，您可以将产品 REST 端点名称更改为 `Pet summaries`。这不会影响您现有的 API。 + 您的产品端点的“试用”功能。这允许 API 使用者在您的门户中试用 API。如果您为私有 API 创建产品端点，则试用功能将设置为 `UNAVAILABLE`。有关更多信息，请参阅 [在门户中为 API Gateway 产品 REST 端点启用“试用”功能](apigateway-portals-try-it.md)。 + 如果您目前已为 REST API 定义了文档部分，则可以导入文档或覆盖现有文档，然后使用 [GitHub 风格 Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) 创建新的产品级文档。任何文档覆盖都不会传播回您的 API Gateway API 文档部分。如果您导入当前文档部分，API Gateway 会将您的 API 中的更改同步到您的产品 REST 端点。 ## 创建产品 REST 端点 以下步骤演示了如何将产品 REST 端点添加到现有门户产品中。要了解如何同时创建门户产品和产品 REST 端点，请参阅[在 API Gateway 中创建门户产品](apigateway-portals-create-portal-product.md)。 **为产品门户创建产品 REST 端点** 1. 通过以下网址登录到 Amazon API Gateway 控制台：[https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway)。 1. 在主导航窗格中，选择**门户产品**。 1. 选择一个门户产品。 1. 选择**关联的端点**选项卡，然后选择**添加端点**。 1. 要选择您的产品 REST 端点，请在 **API 端点**下选择一个 API，然后选择一个阶段。 1. 要向您的产品 REST 端点添加端点，请选择 API 端点，然后选择**添加到产品**。 API 端点将显示在**选定 API 端点**列表中。 1. 选择**提交**。 1. 您的产品 REST 端点页面现在是草稿状态。选择**草稿 API 参考页面**，然后选择您的产品 REST 端点页面以最终确定页面的内容。 1. 选择**编辑页面**。 1. 要覆盖现有 API Gateway 文档，对于**文档来源**，请打开**覆盖文档**，然后执行以下操作： 1. 对于**显示内容**，请选择**创建覆盖**。 1. 对于**操作名称**，输入新的操作名称。 1. 对于**页面正文**，输入您的自定义文档。 1. （可选）对于**端点**，输入显示在您的门户中的自定义端点。 1. 要允许客户在您的门户中调用您的 API，请选择**“试用”功能**。有关更多信息，请参阅 [在门户中为 API Gateway 产品 REST 端点启用“试用”功能](apigateway-portals-try-it.md)。 1. 对于**版块名称**，输入名称或选择现有版块。当您将产品 REST 端点添加到某版块时，消费者可以在已发布的门户上查看您的内容。 1. 选择**保存更改**。 要允许消费者看到新页面，您仍然需要重新发布您的门户。有关更多信息，请参阅 [在 API Gateway 中发布门户](apigateway-portals-publish-portal.md)。 # 在 API Gateway 中创建产品页面 产品页面可帮助您的产品消费者了解和使用您的产品。该文档属于产品级别，因此任何包含您的产品的门户都有此文档。API Gateway 支持两种用 [GitHub 风格 Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) 编写的产品页面： “概述”页面 创建产品时，API Gateway 会根据您在创建产品时提供的信息自动为您的产品生成**概述**页面。本页面包含无法修改的额外格式设置。您可以修改文本，或从门户产品中移除该页面。 自定义页面 自定义页面是用 Markdown 编写的页面。您可以将本版块用于条款和条件，或者用于介绍产品使用方法的教程。您可以将任何自定义页面更改为概述页面。当您将自定义页面更改为概述页面时，页面内容的格式将与概述页面相匹配。 ## 注意事项 以下注意事项可能会影响您对产品页面的使用： + 本文档不是 API 级别，也不包含任何方法、资源或任何请求参数。要了解如何在 API 级别修改产品文档，请参阅[在 API Gateway 中更新产品 REST 端点](apigateway-portals-update-product-endpoint.md)。 + 不能直接将 `.md` 文件上传到您的产品。 + 您可以通过修改门户产品的页面列表显示顺序，来调整产品页面的排列顺序。有关更多信息，请参阅 [在 API Gateway 中更新门户产品](apigateway-portals-update-portal-product.md)。 + 要使文档更改生效，您需要重新发布包含您的产品的所有门户。 + 如果您有多个门户使用同一个门户产品，则所有门户上的产品页面都相同。要拥有相同的产品 REST 端点但不同的产品页面，请创建多个产品。 ## 创建产品页面 以下过程说明了如何创建产品页面。 **创建产品页面** 1. 通过以下网址登录到 Amazon API Gateway 控制台：[https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway)。 1. 在主导航窗格中，选择**门户产品**。 1. 选择产品。 1. 在**文档**下，选择**创建自定义页面**。 1. 对于**页面标题**，输入页面标题。 1. 对于**正文**，请使用 GitHub 样式 Markdown 输入补充文档。 **预览**部分显示您的内容在门户中的呈现方式。最终的视觉风格可能会根据您的门户设置而变化。 1. 选择**创建产品页面**。 1. 您的产品页面现在是草稿状态。选择**草稿文档页面**，然后选择您的产品页面以最终确定页面的内容。 1. 选择**编辑页面**。 1. 对于**版块名称**，输入名称或选择现有版块。当您将产品页面添加到某版块时，消费者可以在已发布的门户上查看您的内容。 1. 选择**保存更改**。 要允许消费者看到新页面，您仍然需要重新发布您的门户。有关更多信息，请参阅 [在 API Gateway 中发布门户](apigateway-portals-publish-portal.md)。 # 在 API Gateway 中更新门户产品 更新门户产品时，您可以更改产品 REST 端点和产品页面的名称、描述或显示顺序。要修改显示顺序，请修改产品页面的页面列表和产品端点的版块名称。如果您使用 AWS CLI 或 SDK 执行此操作，则需要指定产品页面 ARN 或产品 REST 端点 ARN。您需要重新发布所有使用您的产品的门户，以便您的 API 使用者能够在门户中看到所做更改。 ## 更新门户产品 以下步骤演示了如何更改版块列表以重新排列产品 REST 端点在门户中的显示顺序。在此过程中，我们假设您的门户产品中至少有两个产品 REST 端点。 **更新门户产品** 1. 通过以下网址登录到 Amazon API Gateway 控制台：[https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway)。 1. 在主导航窗格中，选择**门户产品**。 1. 选择产品。 1. 在**文档**选项卡中，为**产品页面**选择**管理**。 1. 拖放产品 REST 端点以对其重新排序。您也可以将产品 REST 端点和产品页面移至草稿页面版块。草稿页面中的页面在您的门户中将不可见。 1. （可选）重命名产品 REST 端点名称或添加新的 API 参考版块。这些更改不会影响您的 REST API。 1. 选择**保存更改**。 # 在 API Gateway 中更新产品 REST 端点 更新产品 REST 端点时，您可以更改产品端点的所有设置，但 REST API 的路径和方法及其部署到的阶段除外。对产品端点所做的任何更改都会自动更新，但是您需要重新发布使用您的产品的所有门户，这些更改才能反映在门户中。 ## 更新产品 REST 端点 以下步骤演示了如何更新产品 REST 端点以使用自定义 API 参考文档覆盖当前 API 文档。 **更新产品 REST 端点** 1. 通过以下网址登录到 Amazon API Gateway 控制台：[https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway)。 1. 在主导航窗格中，选择**门户产品**。 1. 选择产品。 1. 在**文档**选项卡的 **API 参考页面**下，选择产品 REST 端点的名称，例如 **/dogs - GET**。 1. 对于**预览**，选择**编辑页面**。 1. 对于**文档来源**，打开**覆盖文档**。 1. 对于**显示内容**，选择**覆盖现有内容**。 如果选择**移除所有内容**，则内容将从页面中移除，但您可以选择 **覆盖现有内容**以再次访问文档。 1. 在**页面正文**中，使用 [GitHub 风格 Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) 输入自定义 API 参考文档。 本文档不会传播回 API Gateway。 1. 选择**保存更改**。 1. 您必须重新发布所有使用此门户产品的门户，更改才能生效。 # 在 API Gateway 中更新产品页面 更新产品页面时，您可以更改产品页面的所有设置。对产品页面所做的任何更改都会自动更新，但是您需要重新发布使用您的产品的所有门户，这些更改才能反映在门户中。 # 在 API Gateway 中共享门户产品 您可以使用 AWS RAM 跨 AWS 账户共享门户产品。当您共享门户产品时，其他账户可以在其自己的门户中使用您的门户产品。通过共享门户产品，您可以创建组织的统一 API 目录，并在整个 API 生态系统中执行治理标准。同时，共享门户产品为 API 提供者提供了灵活性，使其能够在自己的账户中开发、测试和维护 API。 ## 注意事项 以下注意事项可能会影响您共享门户资源的方式： + 当您与另一个账户共享产品时，该账户无法修改您的 REST API 的任何属性。这包括集成端点、授权策略或阶段配置。 + 当您将另一个账户的门户产品添加到您的门户中时，该门户产品的所有者无法查看或控制您门户的任何其他属性。门户产品所有者仅知道该产品正在您的门户中使用。 + API Gateway 门户产品在 AWS 区域级别共享。 + 您可以将一个资源共享用于多个主体，在创建资源共享之后，您可以向其中添加多个主体。我们建议您尽可能重用资源共享。 + 如果两个账户都属于使用 AWS Organizations 的同一组织，则资源共享会自动被接受。您仍然需要使用 AWS RAM 创建资源共享。 + 如果两个账户都属于使用 AWS Organizations 的同一组织，并且您的组织中已经启用了资源共享，则组织中与您进行共享的所有主体将自动获得对资源共享的访问权限。此过程无需邀请，您可以跳过资源共享。 + 如果您共享产品的账户未在 **12 小时**内接受资源共享，您必须重新共享该资源。 + 创建资源共享后，AWS RAM 会更新您产品的产品共享策略，以阻止未获得明确 `allow` 权限的主体访问。有关更多信息，请参阅《IAM 用户指南》中的[确定是允许还是拒绝账户内的请求](https://docs.aws.amazon.com//IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-denyallow)。 更新后的资源策略如下所示： ``` { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "apigateway:GetProduct", "apigateway:ListEndpoints", "apigateway:ListPages", "apigateway:GetEndpoint", "apigateway:GetPage" ], "Resource": [ "arn:aws:apigateway:us-east-1:111122223333:/portalproducts/product-id", "arn:aws:apigateway:us-east-1:111122223333:/portalproducts/product-id/*" ] } ] } ``` AWS RAM 通过添加以下内容，阻止未获得明确允许权限的主体将您的产品添加到其门户： ``` "StringNotEquals": { "aws:PrincipalAccount": "555555555555" } ``` 要了解如何共享产品，请参阅[在 API Gateway 中与门户所有者共享门户产品](apigateway-portals-share-products.md)。要了解如何将他人与您共享的产品添加到您的门户，请参阅[在 API Gateway 中将共享门户产品添加到您的门户](apigateway-portals-use-shared-products.md)。 # 在 API Gateway 中与门户所有者共享门户产品 作为产品所有者，您可以使用 AWS RAM 与其他 AWS 账户账户中的门户所有者共享您的产品。您对所有产品页面和产品 REST 端点页面拥有完全控制权。 ## 注意事项 以下注意事项可能会影响您共享门户产品的方式： + 您可以随时共享或取消共享门户产品。如果在已发布的门户中正在使用某个门户产品时取消共享，门户所有者将无法查看该门户产品、无法查看对其进行的任何更新，也无法重新发布或预览门户，除非他们移除该门户产品。 + 您可以查看已共享给其他账户的门户产品。 + 您无法修改包含您的门户产品的任何门户，除非该门户是您自己创建的。 ## 共享门户产品 以下步骤演示了如何创建资源共享。 ------ #### [ AWS 管理控制台 ] 要使用 AWS 管理控制台，请参阅《AWS RAM User Guide**》中的 [Creating a resource share in AWS RAM](https://docs.aws.amazon.com/ram/latest/userguide/working-with-sharing-create.html)。 对于**选择资源类型**，选择 **API Gateway 产品**。 ------ #### [ AWS CLI ] 使用以下 [create-resource-share](https://docs.aws.amazon.com/cli/latest/reference/ram/create-resource-share.html) 命令为您的私有自定义域名创建资源共享。可能需要花几分钟时间，才能完成资源和委托人关联。对于主体，请提供账户 ID 或 Organizations ID，例如 `arn:aws:organizations::123456789012:organization/o-1234abcd`。您可以为资源共享提供多个主体。 ``` aws ram create-resource-share \ --region us-west-2 \ --name portal-product-resource-share \ --permission-arns arn:aws:ram::aws:permission/AWSRAMDefaultPermissionAPIGatewayDeveloperPortalProduct \ --resource-arns arn:aws:apigateway:us-west-2:111122223333:/portalproducts/p000000000 \ --principals 222222222222 ``` ------ 要取消共享您的门户产品，请使用 AWS RAM 删除资源共享。 您可以随时修改产品共享策略，以指定哪些主体可以在其门户中使用您的门户产品。 **更新产品共享策略** 1. 通过以下网址登录到 Amazon API Gateway 控制台：[https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway)。 1. 在主导航窗格中，选择**门户产品**。 1. 选择产品。 1. 在**产品共享**选项卡中，为**产品共享策略**选择**管理产品共享策略**。 1. 如果您之前未共享过产品，则您的产品共享策略将拒绝所有其他账户访问您的门户产品。您需要更新策略以允许某些账户访问您的门户产品。 1. 更新产品共享策略后，选择**保存更改**。 # 在 API Gateway 中将共享门户产品添加到您的门户 作为门户所有者，您可以在您的门户中使用其他账户共享给您的门户产品。您对自己的门户拥有完全控制权。 ## 注意事项 以下注意事项可能会影响您共享门户资源的方式： + 要在您的门户中使用产品所有者的产品，您必须接受产品所有者的产品资源共享。如果您和产品所有者属于同一个组织，AWS RAM 可以为您完成部分共享步骤。 + 如果产品所有者在您已发布的门户中取消共享某个产品，该产品仍会在门户上显示，但您必须移除该产品后才能重新发布门户。作为门户所有者，移除门户中的产品是您的责任，产品所有者无法为您执行此操作。 + 您可以查看门户产品、产品页面和产品 REST 端点页面，但无法修改这些资源中的任何内容。 + 如果某个产品是共享给您的，您不能再将其共享给其他账户。 ## （可选）接受资源共享 如果您的产品所有者创建了资源共享，则您有 **12 小时**的时间来接受该共享。如果您和产品所有者在同一个组织中使用 AWS Organizations，则会自动接受共享。如果您所在的组织启用了自动共享资源，则会自动与您共享资源。 ------ #### [ AWS 管理控制台 ] 要使用 AWS 管理控制台，请参阅**《AWS RAM User Guide》中的 [Accepting and rejecting resource share invitations](https://docs.aws.amazon.com/ram/latest/userguide/working-with-shared-invitations.html)。 ------ #### [ AWS CLI ] 要查找与您共享的所有资源，请使用以下 [get-resource-share-invitations](https://docs.aws.amazon.com/cli/latest/reference/ram/get-resource-share-invitations.html) 命令： ``` aws ram get-resource-share-invitations \ --region us-west-2 ``` 使用生成的资源共享 ARN 来接受资源共享邀请。以下 [accept-resource-share-invitation](https://docs.aws.amazon.com/cli/latest/reference/ram/accept-resource-share-invitation.html) 命令接受资源共享。 ``` aws ram accept-resource-share-invitation \ --resource-share-invitation-arn arn:aws:ram:us-west-2:123456789012:resource-share-invitation/1e3477be-4a95-46b4-bbe0-c4001EXAMPLE \ --region us-west-2 ``` ------ ## 向门户中添加共享产品 接受资源共享后，将产品添加到您的门户中。 ------ #### [ AWS 管理控制台 ] **向门户中添加共享产品** 1. 通过以下网址登录到 Amazon API Gateway 控制台：[https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway)。 1. 在主导航窗格中，选择**门户**。 1. 选择一个门户。 1. 在**产品**选项卡中，对于**门户产品**，选择**添加产品**。 1. 向门户中添加产品。共享产品在产品列表中显示为 `shared`。 1. 选择**保存更改**。 ------ #### [ AWS CLI ] 要查找与您共享的所有门户产品，请使用以下 `get-portal-products` 命令： ``` aws apigatewayv2 get-portal-products \ --resource-owner OTHER_ACCOUNTS \ --region us-west-2 ``` 要将共享门户产品添加到您的门户，请使用以下 `update-portal` 命令： ``` aws apigateway update-portal \ --included-portal-product-arns arn:aws:apigateway:us-west-2:111122223333:/portalproducts/p000000000 \ --region us-west-2 ``` ------ # 在门户中为 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 门户](apigateway-portals-use-portal.md)。 **为产品 REST 端点启用“试用”功能** 1. 在主导航窗格中，选择**门户产品**。 1. 选择产品。 1. 在**文档**选项卡的 **API 参考页面**下，选择产品 REST 端点的名称，例如 **/dogs - GET**。 1. 选择**编辑页面**。 1. 要允许客户在您的门户中调用您的 API，请选择**“试用”功能**。 1. 选择**保存更改**。 1. 您必须重新发布所有使用此门户产品的门户，更改才能生效。 # 删除 API Gateway 中的门户产品 删除门户产品后，将无法恢复。 ## 删除门户产品 以下步骤演示了如何删除门户产品。 **删除门户产品** 1. 通过以下网址登录到 Amazon API Gateway 控制台：[https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway)。 1. 在主导航窗格中，选择**门户产品**。 1. 选择一个门户产品。 1. 选择**删除**。 1. 确认选择，然后选择**删除**。 1. 您必须重新发布所有使用此门户产品的门户，更改才能生效。