在 API Gateway 中更新产品 REST 端点 - Amazon API Gateway

在 API Gateway 中更新产品 REST 端点

更新产品 REST 端点时,您可以更改产品端点的所有设置,但 REST API 的路径和方法及其部署到的阶段除外。对产品端点所做的任何更改都会自动更新,但是您需要重新发布使用您的产品的所有门户,这些更改才能反映在门户中。

更新产品 REST 端点

以下步骤演示了如何更新产品 REST 端点以使用自定义 API 参考文档覆盖当前 API 文档。

更新产品 REST 端点
  1. 通过以下网址登录到 Amazon API Gateway 控制台:https://console.aws.amazon.com/apigateway

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

  3. 选择产品。

  4. 文档选项卡的 API 参考页面下,选择产品 REST 端点的名称,例如 /dogs - GET

  5. 对于预览,选择编辑页面

  6. 对于文档来源,打开覆盖文档

  7. 对于显示内容,选择覆盖现有内容

    如果选择移除所有内容,则内容将从页面中移除,但您可以选择 覆盖现有内容以再次访问文档。

  8. 页面正文中,使用 GitHub 风格 Markdown 输入自定义 API 参考文档。

    本文档不会传播回 API Gateway。

  9. 选择保存更改

  10. 您必须重新发布所有使用此门户产品的门户,更改才能生效。