在 API Gateway 中创建产品 REST 端点 - Amazon API Gateway
创建产品 REST 端点

在 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 端点启用“试用”功能。

  • 如果您目前已为 REST API 定义了文档部分，则可以导入文档或覆盖现有文档，然后使用 GitHub 风格 Markdown 创建新的产品级文档。任何文档覆盖都不会传播回您的 API Gateway API 文档部分。如果您导入当前文档部分，API Gateway 会将您的 API 中的更改同步到您的产品 REST 端点。

创建产品 REST 端点

以下步骤演示了如何将产品 REST 端点添加到现有门户产品中。要了解如何同时创建门户产品和产品 REST 端点，请参阅在 API Gateway 中创建门户产品。

为产品门户创建产品 REST 端点

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

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

  3. 选择一个门户产品。

  4. 选择关联的端点选项卡，然后选择添加端点。

  5. 要选择您的产品 REST 端点，请在 API 端点下选择一个 API，然后选择一个阶段。

  6. 要向您的产品 REST 端点添加端点，请选择 API 端点，然后选择添加到产品。

    API 端点将显示在选定 API 端点列表中。

  7. 选择提交。

  8. 您的产品 REST 端点页面现在是草稿状态。选择草稿 API 参考页面，然后选择您的产品 REST 端点页面以最终确定页面的内容。

  9. 选择编辑页面。

  10. 要覆盖现有 API Gateway 文档，对于文档来源，请打开覆盖文档，然后执行以下操作：

    1. 对于显示内容，请选择创建覆盖。

    2. 对于操作名称，输入新的操作名称。

    3. 对于页面正文，输入您的自定义文档。

    4. （可选）对于端点，输入显示在您的门户中的自定义端点。

  11. 要允许客户在您的门户中调用您的 API，请选择“试用”功能。有关更多信息，请参阅 在门户中为 API Gateway 产品 REST 端点启用“试用”功能。

  12. 对于版块名称，输入名称或选择现有版块。当您将产品 REST 端点添加到某版块时，消费者可以在已发布的门户上查看您的内容。

  13. 选择保存更改。

要允许消费者看到新页面，您仍然需要重新发布您的门户。有关更多信息，请参阅 在 API Gateway 中发布门户。