跳到主要内容

发布 API 版本

当你准备好与消费者分享 API 的最新更改时,你可以发布一个版本。发布版本会创建 API 当前状态的静态表示。消费者可以在你的工作空间中查看 API 版本。你还可以选择将版本添加到你的 私有 API 网络

你可以选择要与你的 API 一起发布的元素,例如定义和集合,以帮助消费者测试和评估你的 API。发布版本后,你可以继续使用 API 并进行更多更改。在你发布新版本之前,你的消费者将继续看到 API 的已发布版本。

你还可以使用 Postman CLI 以编程方式发布 API 版本。

Postman v10 中的版本和发行版有何不同?在 Postman v9 中,版本是你可以同时处理的 API 的主要迭代。在 Postman v10 中,已发布版本是消费者可以引用的 API 的静态表示(如 Postman v9 中的发布)。如果你需要在 Postman v10 中处理 API 的一次以上主要迭代,请创建单独的 API。

向消费者发布 API

发布 API 版本以与消费者共享 API 的当前状态。你可以选择要包含在已发布 API 中的元素(定义和集合)。

如果你的 API 连接到 Git 存储库,发布版本会将所选元素(定义和集合)同步到你在 Postman 云中的工作空间。

要发布 API 版本,请执行以下操作:

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

  2. 如果你将 API 连接到 Git 存储库,请确保你要发布的分支是活动分支。从 Postman 页脚中选择分支菜单,然后选择要激活的分支。

    你必须与远程存储库同步才能发布 API 版本。根据需要 推送或拉取任何更改。

  3. 在 API 的概览中,在Publish your API to consumers下,选择Publish API。(如果你之前发布过一个版本,请选择Published Versions下的Publish。)

  4. 输入版本标签,如果需要,添加任何描述此版本的发行说明

  5. 选择要与此版本一起发布的元素(API 定义和集合)。

  6. 要使此版本在私有 API 网络上可用,请选择添加到私有 API 网络(或请求添加到私有 API 网络,具体取决于你的 角色 )。你可以选择一个文件夹来放置 API 版本,或者创建一个新文件夹。

    你只能从团队或公共工作空间将 API 添加到私有 API 网络。

  7. 选择发布 API

    发布 API 版本

如果你的团队启用了私有 API 网络的 审批流程,你可以请求将已发布的 API 添加到私有 API 网络。 你团队的 API 网络经理将批准该请求。

编辑和删除 API 版本

更多操作图标 你可以使用已发布版本旁边的更多操作图标来编辑和删除 API 版本 。编辑 API 版本使你能够更改版本标签和发行说明。

编辑和删除 API 版本

查看已发布的 API 版本

消费者可以在你的工作空间中查看最新发布的 API 版本。如果你将版本添加到私有 API 网络,消费者也可以在那里查看版本。消费者可以查看使用 API 发布的任何元素,包括 API 的定义和集合。

要在工作空间中查看 API 版本,请执行以下操作:

  1. 在边栏中选择API ,然后选择一个 API。
  2. 在 Published Versions下,选择一个版本。
  3. 要查看另一个版本,请在 API 名称旁边的版本下拉列表中选择它。

要返回 API Builder,请选择 API 名称旁边的版本下拉列表,然后选择Switch to editorSwitch to branch

要查看私有 API 网络上的 API 版本,请执行以下操作:

  1. 在 Postman header 中选择API Network ,然后选择**Private API Network**
  2. 搜索或浏览 API,然后选择一个 API 以查看可用版本。

了解有关在私有 API 网络 上查看 API 的更多信息。