在 API Gateway 中创建产品页面 - Amazon API Gateway
注意事项创建产品页面

在 API Gateway 中创建产品页面

产品页面可帮助您的产品消费者了解和使用您的产品。该文档属于产品级别，因此任何包含您的产品的门户都有此文档。API Gateway 支持两种用 GitHub 风格 Markdown 编写的产品页面：

“概述”页面

创建产品时，API Gateway 会根据您在创建产品时提供的信息自动为您的产品生成概述页面。本页面包含无法修改的额外格式设置。您可以修改文本，或从门户产品中移除该页面。

自定义页面

自定义页面是用 Markdown 编写的页面。您可以将本版块用于条款和条件，或者用于介绍产品使用方法的教程。您可以将任何自定义页面更改为概述页面。当您将自定义页面更改为概述页面时，页面内容的格式将与概述页面相匹配。

注意事项

以下注意事项可能会影响您对产品页面的使用：

  • 本文档不是 API 级别，也不包含任何方法、资源或任何请求参数。要了解如何在 API 级别修改产品文档，请参阅在 API Gateway 中更新产品 REST 端点。

  • 不能直接将 .md 文件上传到您的产品。

  • 您可以通过修改门户产品的页面列表显示顺序，来调整产品页面的排列顺序。有关更多信息，请参阅 在 API Gateway 中更新门户产品。

  • 要使文档更改生效，您需要重新发布包含您的产品的所有门户。

  • 如果您有多个门户使用同一个门户产品，则所有门户上的产品页面都相同。要拥有相同的产品 REST 端点但不同的产品页面，请创建多个产品。

创建产品页面

以下过程说明了如何创建产品页面。

创建产品页面

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

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

  3. 选择产品。

  4. 在文档下，选择创建自定义页面。

  5. 对于页面标题，输入页面标题。

  6. 对于正文，请使用 GitHub 样式 Markdown 输入补充文档。

    预览部分显示您的内容在门户中的呈现方式。最终的视觉风格可能会根据您的门户设置而变化。

  7. 选择创建产品页面。

  8. 您的产品页面现在是草稿状态。选择草稿文档页面，然后选择您的产品页面以最终确定页面的内容。

  9. 选择编辑页面。

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

  11. 选择保存更改。

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