将 API 定义导出到 Postman 进行 API 测试、监视和开发

适用于:所有 API 管理层级

若要增强 API 的开发,可以将 API 管理中的前端 API 导出到 Postman。 将 API 管理中的 API 定义导出为 Postman 集合,以便可以使用 Postman 的工具来设计、记录、测试、监视和协作处理 API。

注释

只有 API 定义可以直接从 API 管理导出到 Postman。 不会导出其他信息,例如策略或订阅密钥。

先决条件

  • 完成以下快速入门:创建一个 Azure API 管理实例。

  • 确保你的实例管理要导出到 Postman 的 API。

    注释

    目前,只能将 HTTP API 从 API 管理直接导出到 Postman。

  • Postman 帐户,可用于访问 Postman for Web。

转到你的 API 管理实例

  1. 在 Azure 门户中,搜索并选择 API 管理服务:

    显示搜索结果中的 API 管理服务的屏幕截图。

  2. 在 API 管理服务 页上,选择 API 管理实例:

    显示 API 管理服务页上的 API 管理实例的屏幕截图。

将 API 导出到 Postman

  1. 在门户中的“API”下,选择一个 API。

  2. 在右键菜单 (...) 中,选择导出>Postman。

  3. 在“运行位置”对话框中,选择要导出到的 Postman 位置。 如果已在本地安装桌面应用,则可以选择该选项。

  4. 在 Postman 中,选择要将 API 导入到的 Postman 工作区。 默认值为“我的工作区”。

  5. 在 Postman 中,选择“从此 API 生成集合”以根据该 API 定义自动生成一个集合。 如果需要,请配置高级导入选项或接受默认值。 选择导入。

    集合和文档被导入 Postman。

    导入到 Postman 的集合体的屏幕截图。

使用 API 管理和 Postman 进行 API 开发

API 开发人员可以使用 Postman 的 API 测试、监视和开发功能快速迭代 API 修改。

然后,可以导出在 Postman 中开发的 API 并将其作为 API 修订导入回 API 管理。 这样,便可以在 Postman 中开发 API,然后将其部署到 API 管理,以便进行运行时访问和管理。 有关详细信息,请参阅 从 Postman API Builder 部署到 Azure API 管理。

Caution

在 Postman 中传递 API 管理订阅密钥或其他敏感数据时,应谨慎操作。 建议使用 Postman Vault 将敏感数据作为保管库机密存储在 Postman 实例中,以便可以安全地重复使用集合和请求中的机密。