使用版本控制

Postman 的版本控制功能为您和您的团队提供了一种协作构建 API 的方式。您可以分叉一个集合、对分叉进行更新、创建拉取请求并将您的更改合并到父集合中。

集合的版本控制不同于 API 版本控制。有关管理多个 API 版本的信息，请参阅版本控制 API。

分叉邮递员元素

fork是元素的一个新实例，您可以在不对父元素进行任何更改的情况下对其进行修改。在 Postman 中，您可以分叉集合和环境。Forking 还使您能够为集合或环境做出贡献，而无需编辑器访问该元素。

分叉集合

要在公共工作区中派生一个集合，您必须在您的配置文件设置中启用您的公共配置文件。有关公开您的个人资料的更多信息，请参阅管理您的帐户。

当你 fork 一个 Postman 集合时，你会在不同的工作空间中创建它的副本。

分叉一个集合：

  1. 在左侧边栏中选择集合。

  2. 三个点图标选择集合名称旁边的三个点。

  3. 选择创建分叉。

    创建在菜单中选择的叉子

    您还可以通过在集合概览选项卡上选择Fork来分叉集合。

  4. 输入 fork 的标签，然后选择一个工作区来保存它。

  5. 选择分叉集合。

    创建分叉选项卡

您的分叉将在选定的工作区中创建。

如果有任何与集合关联的模拟或监视器，它们将不会链接到分叉集合。如果需要，您将需要专门为 fork 创建模拟和监视器。

如果您不是公共工作区的成员，您将无法从工作区中的集合发送请求。要发送请求或对集合进行更改，请将集合派生到您所属的个人工作区或团队工作区。您必须登录 Postman 才能分叉集合。

分叉环境

在 Postman 中创建一个环境：

  1. 在左侧边栏中选择环境。

  2. 三个点图标选择环境名称旁边的三个点。

  3. 选择创建分叉。

    创建环境分支

    您还可以通过在环境概览选项卡上选择Fork来创建一个环境。

  4. 输入 fork 的标签，然后选择一个工作区来保存它。

  5. 选择分叉环境。

    Fork 环境选项卡

您的分叉环境将在选定的工作区中创建。您将能够在环境中以及 Postman 右侧的环境下拉列表中查看分叉环境。

分叉环境的环境下拉菜单

查看分叉信息

分叉信息提供有关分叉和创建它们的用户的详细信息。您将能够识别正在积极使用并为您的 API 做出贡献的用户。

要查看已派生集合或环境的用户列表：

  1. 选择分叉图标旁边的数字叉子图标以显示具有活动分叉的用户列表。

    查看分叉信息计数

要查看集合的分叉列表：

  1. 选择上下文栏中的叉形图标叉子图标。

  2. 在Forks下选择 fork 名称。

    您还可以在Forks下选择用户的头像来查看用户的公开资料。

    查看分叉列表

创建拉取请求

拉取请求仅适用于集合。

当您对分叉集合进行了更改后，您可以创建一个拉取请求。创建拉取请求意味着您要将在分叉集合（源）中所做的更改合并到父集合（目标）中。作为拉取请求过程的一部分，您将要求审阅者查看您的更改。审阅者可以对您的更改发表评论，并将决定是否批准它们并将它们合并到父集合中。

创建拉取请求：

  1. 在集合边栏中选择分叉集合。

  2. 三个点图标选择集合名称旁边的三个点。

  3. 选择创建拉取请求。

    创建拉取请求

  4. 选择更改以查看将包含在拉取请求中的内容更改。

    拉取请求更改

  5. 选择概览。

  6. 为您的拉取请求输入标题和描述，并从下拉列表中选择最多 50 位审阅者。审阅者必须对集合具有编辑权限才能合并您的更改。

  7. 选择创建拉取请求。

    创建拉取请求

您选择的审阅者将收到有关您的拉取请求的通知。如果审阅者评论、批准或合并拉取请求，您将收到通知。

审阅者必须对父集合具有编辑权限才能合并更改。如果审阅者只有对集合的查看者访问权限，如果您将他们添加为拉取请求的审阅者，您将看到一个警告图标。

审阅者权限

创建公共拉取请求

要在公共集合上创建拉取请求，您必须将父集合分叉到公共工作区，以便您要求查看它的用户可以访问它。

  1. 开始创建拉取请求中描述的拉取请求过程。您将看到一条说明，告诉您将源集合移动到公共工作区。

  2. 选择要将集合移动到的公共工作区。

  3. 选择移动集合。

    公开源集合

  4. 将集合移动到公共工作区后，继续执行创建拉取请求中的工作流。

创建拉取请求后，您将收到已共享到公共工作区的通知。

拉取请求设置

拉取请求设置可用于Postman Professional 和 Enterprise 计划。

拉取请求设置允许您管理审阅者的权限并分配合并检查。

管理审阅者权限

  1. 在“收藏”边栏中选择收藏。

  2. 三个点图标选择集合名称旁边的三个点。

  3. 选择管理角色。

    集合管理角色

  4. 为您要向其提供编辑器访问权限的用户选择编辑器。

  5. 选择更新角色。

    管理角色

分配合并检查

创建拉取请求后，您可以在批准更改之前分配合并检查。

您可以为拉取请求启用两种不同类型的检查：

  • 批准一次：您需要至少一次批准才能合并拉取请求。
  • 由集合编辑器批准：您需要集合编辑器的批准才能合并拉取请求。

要为特定集合上的拉取请求设置合并检查：

  1. 在“收藏”边栏中选择收藏。
  2. 三个点图标选择集合名称旁边的三个点。
  3. 选择管理角色。
  4. 选择要为集合设置的合并检查。
合并检查

如果未满足拉取请求的合并条件，则将其合并到父集合中的选项将处于活动状态。

合并选项未激活

选择查看合并条件以查看拉取请求要满足的合并条件。

合并条件

观看拉取请求

watch 选项使您能够在团队成员修改拉取请求时收到应用内通知。如果您查看拉取请求，您将收到有关操作的通知，例如添加新评论、批准或取消批准、合并以及编辑或拒绝拉取请求。

要查看拉取请求：

  1. 选择观看。
观看拉取请求

要更改您的观看通知设置：

  1. 选择观看。
  2. 选择或取消选择所需的通知选项。
观看通知的条件

查看已监视拉取请求的通知：

  1. 更改日志图标选择Postman 右上角的铃铛图标。弹出窗口指示有关对拉取请求所做的更改的更多信息。

如果您创建一个拉取请求并从同一个 Postman 帐户对其进行修改，您将不会收到任何有关对拉取请求所做更改的通知。

审查拉取请求

如果您在拉取请求中被标记为审阅者，则可以查看更改、评论、批准或拒绝请求，并在准备好后将分叉集合合并到父集合中。

要查看集合的拉取请求列表：

  1. 导航到集合并选择上下文栏中的拉取请求图标拉取请求图标。
拉取请求列表

每个项目都显示拉取请求的状态，这将OPEN适用于尚未合并或拒绝的任何项目。选择拉取请求的名称以将其打开。

查看差异

查看拉取请求时，查看拉取请求将引入父集合的更改非常重要。fork 和父集合之间的差异称为diff。

查看差异：

  1. 在拉取请求中，查看更改标题下的差异。
查看拉取请求时查看差异

diff 将告诉您更改是添加、删除还是修改。您可以使用拉取请求右侧的跳转到窗格来导航拉取请求中包含的文件夹和 API 请求。

添加评论

作为审阅者添加评论是拉取请求过程的重要组成部分，促进有意义的对话并允许利益相关者在过程中发表意见。

要向拉取请求添加评论：

  1. 更改日志图标选择要评论的更改旁边的评论图标。
  2. 撰写评论后，选择Add Comment。
向拉取评论添加评论

要在您的评论中标记其他用户，请在其用户名前使用@符号。

编辑或拒绝拉取请求

您可以在批准之前编辑拉取请求的详细信息，也可以拒绝它。

刷新、编辑或拒绝拉取请求

要编辑拉取请求详细信息：

  1. 三个点图标选择右上角的三个点，然后选择Edit。
  2. 对拉取请求的标题、描述和审阅者列表进行任何更改。
  3. 选择保存更改。

如果您不想将拉取请求合并到父集合中，您可以拒绝它。拒绝的拉取请求无法重新打开，因此如果您想请求编辑或提供反馈，请添加评论。要拒绝拉取请求：

  1. 三个点图标选择右上角的三个点，然后选择Decline。
  2. 选择拒绝拉取请求。

批准拉取请求

如果您被标记为拉取请求的审阅者，您可以批准拉取请求。

要批准拉取请求：

  1. 选择批准。
  2. 按钮文本现在显示Unapprove。如果您需要撤销您的批准，请再次选择该按钮。
批准拉取请求

拉取请求被批准后，您将在集合的拉取请求列表中看到拉取请求的状态为已批准。

已批准的拉取请求

拉取更新

您可以通过父集合中的任何更改使您的分叉集合保持最新，例如，如果另一个团队成员已将更改合并到父集合中。

  1. 打开拉取请求。Postman 会警告您，自您上次更新后，父集合已更改。
  2. 选择Pull Changes以使用父集合中的更改更新您的 fork。

拉取最近的更改

合并更改

当您准备好将拉取请求或分叉集合中的更改添加到父集合中时，您会将它们合并到父集合中。

合并来自拉取请求的更改

审核拉取请求后，即可将其合并到父集合中。

  1. 从批准的拉取请求中，选择Merge。

    合并拉取请求

    如果自您上次更新 fork 以来父集合有任何更改，您可以在合并之前提取这些更改。

  2. 选择以下合并选项之一：

    • 合并更改：将更改合并到父集合中。不会对分叉集合进行任何更改。您必须具有对父集合的编辑权限。
    • 合并更改和更新源：将更改合并到父集合中。父集合中的任何差异也会对分叉集合产生影响。您必须拥有对父集合和派生集合的编辑者权限。
    • 合并更改并删除源：将更改合并到父集合中。合并后，分叉的集合被删除。您必须拥有对父集合和派生集合的编辑者权限。
    合并分叉选项

  3. 选择合并。

合并来自分叉集合的更改

如果您对集合具有编辑权限，则可以将分叉合并到父集合中，而无需通过拉取请求流程。例如，如果您在个人工作区中使用复刻来组织您的工作，您可以将复刻中的更改直接合并回父集合中。但是，如果您正在与其他人协作，则直接合并缺乏拉取请求过程中内置的保护措施，并且许多团队需要将拉取请求作为其版本控制工作流程的一部分。

要在不打开拉取请求的情况下合并来自 fork 的更改：

  1. 在集合边栏中选择分叉集合。

  2. 三个点图标选择集合名称旁边的三个点。

  3. 选择合并更改。

  4. 查看差异并选择Merge all changes。

    合并分叉

  5. 继续合并拉取请求中的更改中描述的合并过程。

解决冲突

当您尝试将更改合并到更新的父集合中并且 Postman 无法自动解决两个集合之间的差异时，会发生合并冲突。如果您在尝试合并分叉集合时遇到冲突，则需要在继续之前决定如何解决它们。

合并冲突可能涉及多个工作区中的更改。

要解决合并冲突：

  1. 看看这两个集合之间的差异。Source行显示您的 fork 上的更改，Destination行显示父集合上的更改。
  2. 选择合并时要包含的版本旁边的使用此选项。
拉取更改

解决冲突后，将启用“拉取更改”按钮，您可以拉取更新。

下一步

您还可以对在 Postman 中设计和构建的API 使用版本控制。