跳到主要内容

使用远程 Git 存储库

GitHub Enterprise Server、GitLab Self-Managed 和 Azure DevOps Server（本地托管）集成在 Postman Enterprise 计划中可用。

你可以将 GitHub、Bitbucket、GitLab 或 Azure DevOps 存储库连接到你的 API，以在 Postman 和存储库之间同步你的 API 定义和集合。

连接后，你可以在 Postman 和远程存储库中的分支之间推送和拉取更改。当需要发布时，你可以发布 API 版本以使你的更改可供消费者使用。

连接到存储库概述​

你可以将 Postman 中的 API 连接到基于 Git 的远程存储库。这使你能够在存储库和 Postman 之间同步更改。你可以连接到 云托管存储库 或 本地存储库 。

连接到存储库时请记住以下几点：

  • 用于身份验证的用户帐户需要对存储库的完全访问权限。要为 API 做出贡献，每个用户都必须使用自己的帐户进行身份验证。
  • 你可以将一个或多个 API 连接到远程存储库。你可以使用文件夹或分支在存储库中将 API 分开。了解有关 将多个 API 连接到同一存储库的 更多信息。
  • 对于 Azure DevOps 连接，请确保为你的组织启用第三方应用程序访问。如果你不启用第三方访问，Postman 将无法连接到你的存储库。在 Azure DevOps 中，转到你的 组织设置 ，选择策略，然后打开Third-party application access via OAuth旁边的开关。（连接到本地托管的 Azure DevOps Server 存储库不需要启用第三方访问。）
  • 对于 GitHub 连接，GitHub 对每个用户每个应用程序有 10 个授权令牌的限制。如果你与同一用户创建十个以上的连接，则超出此限制的令牌将按照它们创建的顺序被撤销。团队可以使用其他 Postman 帐户创建十多个集成。

连接到云托管的存储库​

你可以连接到托管在云中的 GitHub、Bitbucket、GitLab 或 Azure DevOps 存储库。

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

  2. 在 Connect repository下，选择Connect并选择要连接的存储库类型。

  3. 将打开一个浏览器选项卡，要求你登录到你的存储库。按照屏幕上的说明进行操作。完成后，关闭浏览器选项卡并返回 Postman。

  4. 在“连接你的存储库”页面上，输入组织或工作空间以及将存储 API 的存储库。（对于 GitLab，为你的 API 输入组和项目。）

  5. 选择 API 的初始分支。你在 Postman 中所做的任何更改都存储在初始活动分支中。（你可以随时切换到另一个分支以使其成为活动分支。）

  6. 选择API 模式目录和集合目录，API 定义和集合将存储在存储库中。请记住以下几点：

    • 如果将这些字段留空，将在存储库的根目录中创建一个postman/schemas或目录。postman/collections
    • 如果你选择一个已经有 API 定义的目录，你将在第一次拉取更改时被询问在 Postman 中使用哪个定义。
    • 集合目录不能是架构目录的父级或子级。

  7. 选择连接存储库。

Postman 存储你的授权帐户，以便你可以使用它们连接到其他存储库和服务。了解有关 管理远程存储库连接帐户 的更多信息。

连接到云托管的 repo

连接到本地存储库​

如果你使用的是 Postman 企业计划 ，则可以连接到本地托管的 Git 存储库。要连接到 GitHub Enterprise Server 或 GitLab Self-Managed ，请在 Postman 中创建一个新安装的应用程序。要连接到 Azure DevOps 服务器 ，请使用个人访问令牌。

使用 Postman 桌面应用程序 连接到 GitHub Enterprise Server、GitLab Self-Managed 或 Azure DevOps Server。你不能使用 Postman Web 应用程序 连接到本地 GitHub 存储库。

连接到 GitHub Enterprise Server 或 GitLab Self-Managed​

要连接到托管在 GitHub Enterprise Server 或 GitLab Self-Managed 中的存储库，请在 Postman 中 创建一个已安装的应用程序。 要完成此过程，你还需要在 GitHub Enterprise Server 或 GitLab Self-Managed 中创建一个 OAuth 应用程序。你需要为域 URL 完成此过程一次。创建安装的应用程序后，团队中的任何人都可以使用它连接 到使用相同域 URL 的存储库 。

创建已安装的应用程序​

安装的应用程序 通过使团队的所有成员能够使用相同的存储授权详细信息来简化添加集成的过程。要创建已安装的应用程序，你必须具有 团队管理员角色 。

要为 GitHub Enterprise Server 或 GitLab Self-Managed 创建已安装的应用程序，请执行以下操作：

  1. 在 Postman 中，通过选择Team > Team Settings打开 Team Settings 。

  2. 选择已安装的应用程序。

  3. 选择要为其添加已安装应用程序的存储库提供程序（GitHub Enterprise Server或GitLab Self-Managed）。

  4. 输入名称以帮助你稍后识别已安装的应用程序。

  5. 输入存储库的域 URL。域 URL 的格式如下：

    • GitHub Enterprise Server - 使用 Git 服务器的基本 URL，例如：https://my-github-server.example.com
    • GitLab 自我管理- 使用 Git 服务器的基本 URL，例如：https://gitlab.example.com

  6. 按照 Git 提供商（ GitHub Enterprise Server 或 GitLab Self-Managed ）的说明创建 OAuth 应用程序。

    • 对于主页 URL，请输入：https://www.postman.com
    • 对于Authorization callback URL或Redirect URI，输入 Postman 中提供的授权回调 URL：https://integration-oauth.pstmn.io/v1/api-git-callback.html

  7. 注册 OAuth 应用程序后，复制应用程序的客户端 ID和客户端密码并将它们输入到 Postman 中。

  8. 选择保存以完成创建已安装的应用程序。

创建已安装的应用程序

使用已安装的应用程序连接 API​

在你 创建安装的应用程序 后，团队中的任何 API 编辑器都可以使用它将 API 连接到 GitHub Enterprise Server 或 GitLab Self-Managed。

要使用已安装的应用程序连接 API，请执行以下操作：

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

  2. 在 Connect repository下，选择Connect并选择GitHub Enterprise Server或GitLab Self-Managed。

  3. 选择存储库的授权域并选择Authenticate。

    使用已安装的应用程序

  4. 将打开一个浏览器选项卡，要求你登录到你的存储库。按照屏幕上的说明进行操作。完成后，关闭浏览器选项卡并返回 Postman。

  5. 对于 GitHub，输入将存储 API 的组织和存储库。对于 GitLab，为你的 API 输入组和项目。

  6. 选择 API 的初始分支。你在 Postman 中所做的任何更改都存储在初始活动分支中。（你可以随时切换到另一个分支以使其成为活动分支。）

  7. 选择API 架构目录和集合目录，API 定义和集合将存储在存储库中。请记住以下几点：

    • 如果将这些字段留空，将在存储库的根目录中创建一个postman/schemas或目录。postman/collections
    • 如果你选择一个已经有 API 定义的目录，你将在第一次拉取更改时被询问在 Postman 中使用哪个定义。
    • 集合目录不能是架构目录的父级或子级。

  8. 选择连接存储库。

连接到 Azure DevOps 服务器​

要将 API 连接到托管在 Azure DevOps Server 中的存储库，请使用个人访问令牌。

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

  2. 在 Connect repository下，选择Connect并选择Azure DevOps Server。

  3. 输入存储库的域 URL 。你可以输入一个新域或从列表中选择你之前使用过的域。使用 Git 服务器的名称和端口以及集合，例如：https://my-azure-server:8080/my-collection

  4. 输入个人访问令牌以访问存储库。确保令牌具有在“连接你的存储库”页面上指定的所需权限。

  5. 选择下一步。

    使用个人访问令牌

  6. 输入将存储 API 的组织和存储库。

  7. 选择 API 的初始分支。你在 Postman 中所做的任何更改都存储在初始活动分支中。（你可以随时切换到另一个分支以使其成为活动分支。）

  8. 选择API 模式目录和集合目录，API 定义和集合将存储在存储库中。请记住以下几点：

    • 如果将这些字段留空，将在存储库的根目录中创建一个postman/schemas或目录。postman/collections
    • 如果你选择一个已经有 API 定义的目录，你将在第一次拉取更改时被询问在 Postman 中使用哪个定义。
    • 集合目录不能是架构目录的父级或子级。

  9. 选择连接存储库。

Postman 存储你的授权帐户，以便你可以使用它们连接到其他存储库和服务。了解有关 管理远程存储库连接帐户 的更多信息。

管理远程存储库的连接帐户​

将 API 连接到远程存储库后，API 的其他编辑者必须进行身份验证才能为 API 做出贡献。Postman 将在编辑者下次打开 API 时提示他们进行身份验证。

Postman 存储你已授权的帐户。连接到一个存储库后，你可以连接到使用同一 Git 提供程序的其他存储库，而无需重新进行身份验证。

设置图标 要管理你已授权的服务，请选择标题中的设置图标 ，选择设置，然后选择关联帐户选项卡。了解更多关于 管理关联账户的 信息。

将多个 API 连接到同一存储库​

你可以将 Postman 中的多个 API 连接到同一个 Git 存储库。 对于每个 API，请按照连接到存储库 中的步骤设置 Git 集成。

确保你的 API 在存储库中保持分离非常重要，以避免一个 API 的更改应用到另一个 API。你可以使用文件夹或分支在存储库中分隔 API。

使用文件夹分隔 API​

你可以通过为存储库中的每个 API 使用不同的文件夹来将 API 分开。例如，如果你有一个emailsAPI 和一个 API，则你的存储库中的分支sms可以具有以下文件夹结构：main

  • /emails/postman/schemas``emails- API 的模式
  • /emails/postman/collections``emails- API 集合
  • /sms/postman/schemas``sms- API 的模式
  • /sms/postman/collections``sms- API 集合

确保在 将 API 连接到存储库 时为 API 的架构和集合选择正确的文件夹。

集合目录不能是架构目录的父级或子级。

用分支分离 API​

你可以通过为存储库中的每个 API 使用不同的分支来保持 API 独立。例如，如果你有一个notifications-v1API 和一个notifications-v2API，则你的存储库中可以具有以下分支和文件夹结构：

  • notifications-v1分支
    • /postman/schemas``notifications-v1- API 的模式
    • /postman/collections``notifications-v1- API 集合
  • notifications-v2分支
    • /postman/schemas``notifications-v2- API 的模式
    • /postman/collections``notifications-v2- API 集合

对于连接到存储库的 每个 API，你必须使用唯一的分支和文件夹组合。例如，如果你将一个 API 连接到/postman/schemas分支上的文件夹notifications-v1，则不能将另一个 API 连接到同一分支上的同一文件夹。你必须使用不同的分支或不同的架构文件夹。

在处理 API 时，你可以切换分支并推送或拉取任何分支的更改。为了保持你的 API 独立，请始终确保在推送或拉取更改之前位于正确的分支上。

断开远程存储库​

断开远程存储库后，你将无法再在 Postman 和存储库之间同步更改。

  1. 在边栏中选择API ，然后选择一个 API。
  2. Git 分支图标 在右侧边栏中选择源代码管理图标 。
  3. 在Source Control窗格中，选择更多操作图标 更多操作图标 并选择Disconnect repository from Postman。
  4. 输入要确认的 API 名称，然后选择Disconnect。

下一步​

将远程存储库连接到 API 后，你可以：