# API Gateway 门户
<a name="apigateway-portals"></a>

您可以使用 API Gateway 门户，在网页中与 API 使用者共享您的 API 和 API 文档。一个门户包含一组*门户产品*。每个门户产品都是 REST API 的逻辑分组，包含您为 API 使用者创建和发布的文档。门户中的产品页面包含门户产品级别的自定义文档。*产品 REST 端点页面*包含每个 REST API 的文档以及 REST API 的路径、方法和阶段。产品页面和产品 REST 端点页面的组合提供了完整的文档，让 API 使用者能够学习如何开始使用 REST API。

可使用门户来执行以下操作：
+ 在从创建 API 到记录和分发的整个 API 生命周期中使用 API Gateway。
+ 跨 AWS 账户共享门户产品。
+ 为您的门户产品自定义和共享一个中心位置，并提供产品页面。

## 注意事项
<a name="apigateway-portals-considerations"></a>

以下注意事项可能会影响您对 API Gateway 门户的使用：
+ 您只能创建用于共享 REST API 的门户。
+ 门户是在 AWS 区域级别创建的。您的门户只能包含与创建门户所在的同一区域内的 REST API。
+ 您只能使用 AWS 管理控制台、AWS CLI 或 AWS SDK 来创建和共享您的门户。
+ 您只能使用 Amazon Cognito 用户池控制对门户的访问。您的门户使用者可以通过用户池直接登录，也可以通过第三方身份提供者（IdP）进行联合身份验证。如果您使用 Amazon Cognito 用户池，则无法为用户池设置客户端密钥。有关更多信息，请参阅 [Amazon Cognito 用户池](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools.html)。