GitHub

GitHub Enterprise Server 集成仅适用于 Postman Enterprise 计划。

通过 Postman 到 GitHub 的集成,将您的 Postman 集合备份到 GitHub,这是一种基于云的 Git 存储库托管服务。

设置 GitHub 集成需要您生成 GitHub 个人访问令牌并配置您希望如何备份您的集合。

要将数据从 GitHub 存储库导入 Postman,请参阅通过 GitHub 存储库导入

内容

API 与 GitHub 同步

Postman 9.0 引入了将 Git 存储库连接到 API 的功能。您可以直接将 GitHub 存储库连接到 API Builder 中的 API,而不是使用集成。这提供了模式和关联集合的双向同步,并添加了强大的新功能,用于在 Postman 和您的存储库之间同步分支和发布标签。有关新的 repo 同步功能的更多信息,请参阅版本控制 API

生成 GitHub 个人访问令牌

要与 GitHub 集成,您需要一个 GitHub 个人访问令牌。

  1. 登录到GitHub
  2. 如果您还没有个人访问令牌,请生成一个新的
  3. 要启用备份集合,请确保选择repouser范围。
  4. 保存生成的令牌以供以后使用。

有关生成令牌的更多信息,请参阅GitHub 文档

在 GitHub 上备份集合

您可以将 Postman 集合备份到 GitHub 存储库。创建集成后,对 Postman 中集合的任何新更改也将显示在 GitHub 存储库中。

  1. 主页选择集成

    主页和集成
  2. 搜索并选择GitHub

    GitHub 集成

  3. 在备份集合旁边,选择添加集成

  4. 输入您的 GitHub个人访问令牌并选择Authenticate and Proceed

    访问令牌
  5. Postman 验证令牌后,您可以配置集成:

    • 给集成起一个昵称。
    • 选择包含要备份的集合的工作区。
    • 选择要备份的集合。
    • 选择要在其中备份集合的 GitHub 存储库。
    • 输入要推送集合的目录。如果该目录不存在,Postman 将为您创建它。如果不指定目录,Postman 将创建一个Postman Collections目录。
    • 输入存储库中集合的文件名。
    • 输入要推送集合的分支。该分支必须已经存在于您的存储库中。如果不指定分支,Postman 会将集合推送到存储库的默认分支。
    配置 GitHub 集成
  6. 要完成设置集成,请选择添加集成

保存到 Postman 集合的每个更改都会自动以 JSON 格式将更改提交到您的 GitHub 存储库。导航到您的 GitHub 存储库以查看您的收藏。

Github 集成屏幕

将集合备份到自定义域上的 GitHub

要将集合备份到自定义域上的 GitHub,请按照与备份集合相同的步骤操作,但有以下区别:

  1. 在 Postman 中搜索 GitHub 集成后,选择Backup a collection (custom domain)旁边的Add Integration

  2. 连同您的个人访问令牌一起,输入您的 GitHub 自定义域,然后选择Authenticate and Proceed

    GitHub 自定义域
  3. 配置与您的集合、存储库、目录、文件名和分支的集成。

  4. 要完成设置集成,请选择添加集成

静态 IP 支持

如果您的网络位于需要来自允许列表的 IP 地址的防火墙后面,您必须使用静态 IP 地址来启用到自定义域上 GitHub 的集合备份。

请联系您的 IT 团队,在防火墙中将以下静态 IP 列入许可名单:

  • 美国东部:3.212.102.200

将此 IP 地址列入白名单后,对此集成的调用将能够连接到您的网络并允许集成按预期工作。

GitHub 集成故障排除

如果您的 GitHub 集成有问题或您的数据未推送到 GitHub,请检查以下要求:

  • 您在与要推送到 GitHub 存储库的内容相同的工作区中添加了 GitHub 集成。
  • 您在 Postman 中选择了正确的 GitHub 集成。例如,如果您使用自定义域,请确保您选择了备份集合(自定义域)集成。
  • 您使用文件初始化了 GitHubREADME.md存储库。创建新存储库时,您可以选中添加自述文件复选框。
  • 您在创建 GitHub个人访问令牌user时选择了范围。repo
  • 您在设置集成时指定的分支已存在于 GitHub 上。如果分支尚不存在,邮递员将不会创建它。
  • 您有权推送到分支。
  • 如果您的企业版 GitHub 是本地或自托管的,请咨询您的 IT 团队以了解防火墙要求

编辑集成以进行任何必要的更改,然后重试。如果集成仍然不起作用,请尝试删除集成并重新添加。