部署 API

通过连接到Amazon API Gateway掌握 Postman 中的 API 部署。连接到 API Gateway 后,您可以在 Postman 中查看您的 API 部署状态和历史记录。此集成支持 HTTP 和 REST API 的 OpenAPI 3.0 模式。

对于 HTTP API,您还可以选择将架构从 Postman 导出到 Amazon API Gateway。然后,您可以使用 AWS 控制台将导出的架构部署到阶段。或者,您可以直接从 Postman 将 HTTP API 模式部署到 API Gateway 中的阶段。

连接到 Amazon API 网关

要在 Postman 中连接到 Amazon API Gateway,请在左侧栏中选择API,然后选择要连接的 API 和版本。选择部署选项卡,然后选择AWS API Gateway

连接到 AWS API 网关

设置与 API Gateway 的连接时,您可以选择通过创建 AWS IAM 角色使用 AWS 访问密钥进行身份验证。请按照以下所选方法的步骤进行操作。

使用 AWS IAM 角色进行身份验证

要使用 AWS IAM 角色设置与 Amazon API Gateway 的连接,请在AWS Authentication Mechanism下选择IAM

连接 AWS IAM 角色

输入此集成的昵称并选择AWS API 类型(HTTP 或 REST)。

接下来,在 AWS 中为 Postman 创建一个 IAM 角色:

  1. 导航到AWS IAM 控制台并选择Create role

  2. 选择受信任实体的类型下,选择另一个 AWS 账户

  3. 输入 Postman 的AWS 账户 ID258201882842

  4. 在选项下,选中需要外部 ID复选框并输入 Postman 的外部 ID您可以在第 1 步:创建 IAM 角色下找到外部 ID 。

    有关更多信息,请参阅有关使用外部 ID 的 AWS IAM 指南

  5. 选择下一步:权限

  6. 选择现有 IAM 策略或选择创建策略。如果您要创建策略,请使用以下 JSON:

    {
        "Version": "2012-10-17",
        "Statement": [
            {
                "Sid": "Stmt909923626743",
                "Effect": "Allow",
                "Action": [
                    "apigateway:GET"
                ],
                "Resource": [
                    "*"
                ]
            }
        ]
    }
  7. 选择下一步:标签

  8. 选择下一步:查看

  9. 添加角色名称角色描述,然后选择创建角色

从 AWS复制Role ARN并将其粘贴到 Postman 的Step 2: Enter role ARN and region下。接下来,输入API Gateway 所在的AWS Region并选择API Gateway。准备好后,选择Connect

使用 AWS 访问密钥进行身份验证

要使用 AWS 访问密钥设置与 Amazon API Gateway 的连接,请选择AWS Authentication Mechanism下的访问密钥

使用 AWS 访问密钥连接

接下来,输入有关连接的信息:

  • 输入此集成的昵称
  • 选择AWS API 类型(HTTP 或 REST)。
  • 输入您的 AWS 账户的访问密钥 ID秘密访问密钥。(了解如何在 AWS 中找到您的凭证。)
  • 输入API Gateway 所在的AWS 区域,然后选择API Gateway

准备好后,选择Connect

在 Postman 中查看 API 部署

连接到 Amazon API Gateway 后,您可以在 Postman 中查看 API 架构的导出和部署历史记录。在左侧边栏中选择API,选择 API 和版本,然后选择部署选项卡。

  • 对于每个阶段,您都可以查看活动部署、创建日期和上次更新日期。选择一个阶段以查看其他详细信息,包括调用 URL 和阶段描述(来自 AWS)。
  • 对于 Postman 的每次导出,您都可以查看导出的来源和导出时间。
  • 对于每个部署,您可以查看 ID、描述和创建日期。
查看 API 部署

部署选项卡中,您可以执行以下操作:

  • 要在 AWS 中查看您的 API Gateway,请选择AWS Gateway ID
  • 要导出或部署您的架构,请选择部署 API(仅适用于 HTTP API 架构)。了解有关部署 API 的更多信息。
  • 要在 AWS 中查看 API Gateway 的指标,请选择View Dashboard
  • 要查看最新部署状态,请选择刷新图标刷新图标
  • 要编辑或删除与 Amazon API Gateway 的连接,请选择三个点三个点图标

导出和部署您的 API

导出 HTTP API 架构使其在连接的 Amazon API Gateway 中可用。从 Postman 导出架构后,使用 AWS 控制台配置架构并将其部署到 API Gateway 中的阶段。或者,在导出时,您可以选择将模式直接从 Postman 部署到连接的 API 网关中的阶段。部署模式后,用户可以开始调用 API。

只能从 Postman 导出和部署 HTTP API 模式。要部署 REST API 架构,请使用 AWS 控制台。

  1. 通过选择左侧边栏中的API,然后选择 API 和版本来打开您的 API 。

  2. 选择部署选项卡,然后选择部署 API

    您还可以从变更日志中导出和部署您的 API。更改日志图标在右侧上下文栏中打开 Changelog ,选择三个点图标版本旁边的三个点,然后选择Deploy Schema

  3. 选择要部署的版本、分支或发行版。了解有关对 API 进行版本控制创建发布的更多信息。

  4. (可选)如果您想在导出后立即将架构部署到阶段,请选择Deploy on a stage。选择要将架构部署到的 AWS 阶段,然后输入简短描述。

    要部署您的架构,您的网关必须至少有一个配置了集成的路由。

  5. 选择部署

部署 API

从 Postman 推送和部署模式时, API 网关对 Open API(供应商扩展)的扩展被保留。Postman 将 API Gateway 中存在的任何扩展合并到模式中,然后再将合并的模式推送到 API 网关。