在 API Gateway 中创建门户产品 - Amazon API Gateway
注意事项创建门户产品

在 API Gateway 中创建门户产品

以下过程说明了如何创建门户产品。门户是门户产品的集合。创建门户产品后，您可以创建产品 REST 端点和产品页面。要了解有关门户产品的信息，请参阅 API Gateway 中的门户产品。

注意事项

以下注意事项可能会影响您创建门户产品的方式：

  • 您的门户产品可以包含私有和公共 REST API。试用功能不支持私有 API，因此您的门户在外观上会有所不同。作为门户所有者，您可能需要提供相关文档进行说明。

  • 如果您使用 AWS CLI 或 AWS SDK 创建门户产品，则您的门户将没有任何产品端点或产品页面。您需要使用 AWS CLI 或控制台添加这些资源。要了解如何创建产品 REST 端点，请参阅在 API Gateway 中创建产品 REST 端点。要了解如何创建产品页面，请参阅在 API Gateway 中创建产品页面。

创建门户产品

以下过程说明了如何创建门户产品。

创建门户产品

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

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

  3. 选择创建产品。

  4. 对于产品名称，输入您的门户产品的名称。

  5. 对于产品描述，请输入描述。

  6. 选择下一步。

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

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

    注意

    在未先选择添加到产品之前，请勿选择下一步。

    门户产品

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

  9. 选择下一步。

  10. 检查您的选择，然后选择创建产品。

使用控制台创建门户产品后，您的所有产品页面和产品 REST 端点页面均为草稿，不会出现在门户中。要让消费者看到您的产品页面和产品 REST 端点页面，您需要将草稿添加到版块中。如果您使用 AWS CLI 或 AWS SDK 创建门户产品，则可以在 AWS CLI 命令中将草稿添加到版块中。无论您如何将草稿添加到版块中，都必须发布使用您的门户产品的门户，这样消费者才能看到您的产品。

将草稿添加到页面版块

  1. 您的草稿将在文档选项卡中列出。您的产品页面有草稿文档页面，产品 REST 端点页面有草稿 API 参考页面。选择草稿 API 参考页面。

  2. 选择草稿 API 参考页面。

    如果您没有任何产品 REST 端点，则没有任何草稿 API 参考页面。要了解如何创建产品 REST 端点，请参阅在 API Gateway 中创建产品 REST 端点。

  3. 选择编辑页面。

  4. 在此页面上，您可以覆盖任何现有的 API 文档部分或使用 API Gateway 文档。要允许消费者看到您的产品 REST 端点页面的内容，请在版块名称下输入名称。如果这是 /pets-GET 端点，则页面名称可能是 Pets。

  5. 选择保存更改。

  6. 您创建的新页面名称将显示在 API 参考页面部分下。

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