APIMatic

Postman 的 APIMatic 集成将 Postman 集合转换为 API 描述格式,例如 Swagger、RAML 或 API 蓝图,然后定期在 GitHub 上备份生成的文件。

先决条件

要设置与 Postman 的 APIMatic 集成,您将需要:

配置 APIMatic 集成

定期将集合备份到 GitHub 存储库:

  1. 在 Postman主页上,选择集成

  2. 在搜索栏中输入APIMatic并选择结果。

    浏览并选择 APIMatic

  3. 选择添加集成

  4. 您的浏览器将打开一个新的Authorize Postman页面,该页面允许 Postman 访问您的 GitHub 存储库。选择授权 postmanlabs。授权过程完成后,该页面将告诉您关闭选项卡并在 Postman 中继续。

    如果您没有登录 GitHub,系统会提示您登录。

  5. 在 Postman 中,输入有关集成的信息:

    • APIMatic API 密钥- 您的APIMatic 集成密钥
    • 昵称- 为集成创建昵称。
    • 选择工作区- 选择要备份的集合所属的 Postman 工作区。
    • 选择收藏- 选择您要备份的 Postman 收藏。
    • 选择存储库- 选择您的收藏将备份到的 GitHub 存储库。
    • 输入目录- 在 GitHub 存储库中添加要备份您的集合的目录。如果不存在具有该名称的目录,则会在您添加集成时创建该目录。
    • 输入文件名- 为备份文件创建文件名。
    • 选择格式- 选择您要备份集合的格式。
    • 输入分支- 添加要在其中备份集合的 GitHub 分支的名称。此分支必须已经存在,如果您指定无效的分支名称,集成过程将失败。
  6. 选择添加集成

    APIMatic 集成表格

创建集成后,选择它以查看有关集成的详细信息,包括其运行日志。

APIMatic 集成运行日志

此集成每天在 12:00 UTC 运行一次。如果您对收藏进行更改,转换器会在下一次运行中获取这些更改。如果您的收藏没有更新,则不会将更新推送到 GitHub。