跳到主要内容

部署 Azure API

Azure API 管理 使开发人员能够为托管在 Microsoft Azure、其他云平台或本地的 API 部署 API 网关。连接到 Azure API 管理后,你可以从 Postman 中查看 API 部署状态和历史记录。你还可以将 OpenAPI 定义从 Postman 导出到 Azure API 管理,或从 Azure 导入定义以在 Postman 中使用它。

连接到 Azure API 管理

  1. 在边栏中选择API ,然后选择一个 API。

  2. 选择部署,然后选择Microsoft Azure

  3. 系统将提示你授权 Postman 访问你的 Microsoft Azure 帐户。授予访问权限后,你可以关闭浏览器选项卡并返回到 Postman。

  4. 输入有关要连接到 API 的 Azure API 管理服务的信息:

  5. 要连接更多 Azure API 管理服务,请选择+ 添加服务。要删除服务,请选择删除

  6. 添加完服务后,选择“连接”

    Azure API 管理设置

  7. 如果需要,你可以选择从 Azure API 管理导入定义:

    • 要导入定义,请选择定义类型(OpenAPI 2.0 或 OpenAPI 3.0)。然后选择要从中导入定义的Azure 服务并选择**“导入”**导入定义将替换你当前的 API 定义或添加一个新定义(如果不存在)。
    • 如果你不想导入定义,请选择Maybe later。连接到 Azure API 管理后,你可以随时 导入定义。

    安装期间的 Azure API 管理导入定义

查看 Azure API 部署

连接到 Azure API 管理后,你可以在 Postman 中查看 API 定义的部署状态和历史记录。在边栏中选择APIs 并选择一个 API,然后选择**Deployments**

对于每个连接的 API 管理服务实例,你可以查看资源组、位置、订阅和虚拟 IP 地址 (VIP)。

查看 Azure API 管理服务

选择一项服务以查看有关连接的 Azure API 版本的更多详细信息。

  • 修订- 修订 使你能够在不影响消费者的情况下对 API 进行更改并进行测试。对于每个修订,你可以查看修订 ID、创建日期、描述、URL 和 Postman 来源。

    • 使用在线切换将修订设置为离线或在线。消费者无法访问离线修订。
    • 使用Current toggle 使修订成为 API 的当前修订。输入可选说明并选择确认。消费者在调用 API 时访问当前修订版。
  • 变更日志- 变更日志显示你的 API 的部署历史记录。每次将修订设为最新时,Postman 都会向变更日志添加一个条目,包括创建日期、上次更新日期和变更说明。

  • 导出历史记录- 导出历史记录列出了此 API 从 Postman 导出的所有内容。对于每次导出,你可以查看创建日期、Azure 修订版和 Postman 源。

查看服务实例

从服务详细信息视图中,你可以执行以下操作:

从 Azure 导入定义

你可以将定义从连接的 Azure API 管理服务导入到 Postman 中的 API。导入定义将替换你当前的 API 定义或添加一个新定义(如果不存在)。

  1. 在边栏中选择API ,然后选择一个 API。
  2. 选择部署,然后选择导入定义
  3. 选择定义类型(OpenAPI 2.0 或 OpenAPI 3.0)。
  4. 选择要从中导入定义的Azure 服务。
  5. 选择导入

导入定义

将 API 导出到 Azure API 管理

导出 OpenAPI 定义使其在连接的 Azure API 管理服务中可用。支持 OpenAPI 2.0 和 3.0 定义。你可以将定义导出到现有修订或新修订。

  1. 在边栏中选择API ,然后选择一个 API。

  2. 选择部署

  3. 选择要导出到的服务,然后选择导出 API

  4. 选择要导出的定义的来源。你可以选择当前定义或定义的任何 已发布版本。

  5. 输入导出的简短描述。

  6. (可选)如果要将定义导出到现有修订版,请选中该复选框。选择要更新的修订的修订 ID 。

    如果你不选中该复选框,Postman 会将 API 导出到新修订版。

  7. 选择导出

导出 API

导出后,你可以使用当前切换按钮将新的或更新的修订版设为当前修订版。

排查导出问题

如果你在导出定义时遇到问题,请检查以下内容:

  • 某些定义字段(例如名称、描述和协议)必须在当前修订版上更新,而不能在其他修订版上更新。要在不是当前修订版的修订版上更新这些字段,请改为执行手动合并。
  • Azure API 管理不支持 OpenAPI 规范的某些属性。有关详细信息,请参阅 Microsoft 帮助文章 API 导入限制和已知问题