使用 Git 管理更改
连接到远程 Git 存储库后,你可以使用 Postman 更改 API 并与他人协作。你对 API 的定义或集合所做的任何更改总是发生在分支上。你可以在存储库中的任何分支上工作。
如果你 配置了远程存储库 ,Postman 会将你的更改存储在本地缓存中。当你准备好与他人共享你的工作时,将你的更改推送到远程存储库。
使用分支机构
Git 分支可帮助你组织工作并与他人协作。作为 API 生产者,你总是在一个分支上工作。
切换分支
如果你的 Git 存储库有多个分支(例如main
、develop
和功能分支),你可以在 Postman 中的分支之间切换。切换到分支使其成为活动分支。
要切换分支,请选择 Postman 页脚中的 Git 分支下拉菜单,然后选择要激活的分支。切换到分支后,你可以使用 Postman 更改 API 的定义和集合。你所做的任何更改都存储在活动分支中。
Postman 在列表中显示一组有限的分支。如果未列出分支,请在下拉列表的“搜索”框中输入分支名称,然后选择要切换到的分支。
创建一个新分支
功能分支使你能够在不影响存储库中的默认分支的情况下对 API 进行更改。当你创建一个新分支时,Postman 会自动将其设为活动分支。
要在远程存储库中创建一个新分支,请执行以下操作:
- 在边栏中选择API ,然后选择一个 API。
- 在 Postman 页脚中选择 Git 分支下拉菜单。
- 在搜索框中输入新分支的名称。
- 选择从当前分支创建分支。Postman 根据当前活动分支创建新分支。
推动和拉动变化
在你处理 API 时,Postman 会跟踪你对活动分支所做的更改。使用“源代码管理”窗格查看和管理你的更改历史记录。你可以将你的更改提交并推送到远程存储库,以使你的工作对其他人可用。你还可以提取更改以使你的工作文件与远程存储库保持同步。
要显示或隐藏提交历史记录,请选择Commits。展开提交以查看有关更改的详细信息。如果有多个更改的文件,你可以使用 Commits旁边的下拉菜单来显示文件历史记录或显示所有提交。
提交和推送更改
Source Control窗格显示 Postman 中活动分支的更改数量。
要提交更改并将更改推送到远程存储库,请执行以下操作:
在边栏中选择API ,然后选择一个 API。
在右侧边栏中选择源代码管理图标 。
如果你想在提交和推送更改之前查看更改,请将鼠标悬停在文件上并选择差异图标 。
你可以通过选择旁边的丢弃图标来丢弃文件中的更改 。
要将保存的更改提交到活动分支,请输入提交消息并选择Commit and Push。
如果远程仓库有变化,需要先 拉取变化 ,然后才能提交和推送。
在你推送更改后,你团队中的其他生产者可以切换到分支、拉取更改并查看你所做的更新。
拉动变化
拉动将更改从远程(原始)分支带到你的活动分支。
要从远程分支中提取更改,请执行以下操作:
- 在边栏中选择API ,然后选择一个 API。
- 在右侧边栏中选择源代码管理图标 。拉动图标 表示你的活动分支在远程分支后面的提交数。
- 选择拉动图标将更改引入你的活动分支。
如果有任何冲突,你需要先 解决冲突 ,然后才能完成拉取更改。
解决冲突
如果活动分支中的更改与远程(原始)分支中的更改冲突,则必须先解决冲突,然后才能拉取更改。
要解决冲突,请执行以下操作:
- 在每个受影响的文件旁边,选择保留远程文件或保留本地文件。
- 完成后,选择Pull Changes。
如果有冲突的文件不是 Postman support 的格式,你需要在首选的 Git 客户端中解决冲突。
创建拉取请求
将更改推送到分支后,你可以创建拉取请求 (PR) 以将你的更改合并到另一个分支。例如,如果你正在处理功能分支,则可以创建拉取请求以将你的更改合并到存储库的主分支中。
要创建拉取请求,请执行以下操作:
- 在边栏中选择API ,然后选择一个 API。
- 在右侧边栏中选择源代码管理图标 。
- 选择创建 PR。将打开一个浏览器选项卡,你可以在其中完成创建 PR。
合并 PR 后,请确保切换到你合并更改的 分支并 拉取更改 。
使你的更改对其他人可用
你推送到远程存储库的任何分支和更改对你团队中的其他 API 生产者都是可见的。你还可以 创建拉取请求 以请求团队中的其他人审查你的更改。
要使你的 API 使用者可以使用你的更改,请发布新版本的 API。当你发布一个版本时,API 的定义和集合会同步到你在 Postman 云中的工作空间。消费者可以在你的工作空间中查看版本。你还可以选择将版本添加到你的私有 API 网络。了解有关 发布 API 版本的 更多信息。