跳到主要内容

管理和共享 API

当你使用 API Builder 在 Postman 中 定义 API 时，每个 API 都与一个工作空间相关联。 你可以共享对 API 的访问权限、在评论中讨论它们以及查看架构活动。

分享 API​

你可以通过导航到要在侧边栏中共享的 API 来与协作者共享你的 API。选择它，然后选择更多操作图标 更多操作图标 >共享。

分享API

有关详细信息，请参阅 共享 Postman 元素 。

API 协作​

你可以将 API 移动到共享工作空间以与你的团队协作。

你必须是 API 的编辑者或工作空间管理员才能将 API 移动到另一个工作空间。要了解有关角色和权限的更多信息，请参阅 定义角色 。

在边栏中，选择要共享的 API，然后选择更多操作图标 更多操作图标 >移动。

使用搜索栏查找你要将 API 移动到的工作空间，或通过选择筛选器图标按工作空间可见性进行筛选 过滤器图标 。

你可以将 API 移动到你有权访问的个人、私人、团队和公共工作空间。共享的私人、团队和公共工作空间使你能够与他人协作。

你不能将 API 从团队、私有或公共工作空间移动到个人工作空间。

有关团队内工作空间访问控制的信息，请参阅 角色和权限。

选择工作空间，然后选择Move API。API 中的任何集合都将随 API 移动到新工作空间。

移动API

观看 API​

当属于同一工作空间的团队成员修改 API 时，监视选项使你能够收到电子邮件或应用程序内通知。例如，当团队成员更新 API 的定义、向 API 添加元素或向 API 添加评论时，你将收到通知。

选择“观看”以开始观看 API。

观看选项

有关 API 更改的更多信息，请选择 通知图标 Postman header 中的通知图标。

你还将收到一封电子邮件，其中包含有关更改人、更改内容以及更改时间的信息。

你不会收到有关你所做更改的通知。

你可以在 Postman 中与合作者讨论你的 API，保持对话在上下文中并可供其他利益相关者使用。

API 生产者（ 编辑者角色 ）可以向 API 添加注释。API 消费者（ 查看者角色 ）无法向 API 添加评论，也不会看到 API 生产者所做的评论。但是，API 使用者可以对 API 的 已发布版本发表 评论。

要评论 API，请执行以下操作：

  1. 在边栏中选择一个 API。
  2. 评论图标 选择右侧边栏中的评论图标 。
  3. 输入你的评论并选择添加评论。

评论 API

你还可以向已添加到 API 的集合以及该集合中的请求和文件夹添加评论。了解更多关于 对集合发表评论的 信息。

要对 API 定义留下内联注释，请执行以下操作：

  1. 在边栏中选择一个 API 以将其展开。
  2. 在 API 下选择Definition，然后选择你要评论的定义文件。
  3. 评论图标 通过选择编辑器窗格中的评论图标切换到评论模式 。
  4. 突出显示部分定义，输入你的评论，然后选择添加评论。

添加内联评论

为确保你查看的是最新评论，请选择 刷新图标 评论框中的刷新图标。

你可以在评论中使用 Markdown。查看 GitHub 上的 Markdown Cheatsheet 以获取有关格式化的提示。

要在评论中提及合作者，请键入@后跟他们的姓名，然后从自动建议的列表中选择该人。当你在评论中提及某个用户时，Postman 会向他们发送通知。

评论图标 要管理 API 评论，请在边栏中选择一个 API 或定义文件，然后在右侧栏中选择评论图标 。

将鼠标悬停在你要管理的评论上并执行以下操作之一：

管理 API 评论

如果你拥有工作空间的管理员角色，则可以删除任何贡献者发表的评论，但不能编辑其他人发表的评论。

评论图标 要回复 API 评论，请在边栏中选择一个 API 或定义文件，然后在右侧栏中选择评论图标 。在要回复的评论上选择添加评论。输入你的回复并选择添加评论。

回复 API 评论

在处理完评论后，你可以解析 API 定义的内联评论。打开定义文件并通过选择 评论图标 编辑器窗格中的评论图标切换到评论模式。选择解决以解决评论和任何相关回复。

解决 API 注释

你无法撤消已解决的评论，但你可以通过选择 过滤器图标 评论窗格中的过滤器图标来查看已解决的评论。

你可以 发布 API 以与消费者共享 API 的当前状态。发布 API 时请记住以下几点：

  • 当你发布 API 版本时，API 生产者所做的评论不会随 API 一起发布。
  • API 使用者无法向 API 添加评论，但他们可以向已发布的 API 版本添加评论。

你可以 将 Git 存储库连接 到你的 API，以在 Postman 和存储库之间同步你的 API。在评论 Git 链接的 API 时，请记住以下差异：

使用更新日志​

你可以查看 API 架构和所有链接集合的更改历史记录。变更日志图标 要访问变更日志，请打开一个 API，然后选择右侧栏中的变更日志图标 。

如果你将 API 连接到 Git 存储库，则更改日志将被源代码管理窗格取代。了解有关 API 版本控制 的更多信息。

Changelog 显示了对架构和关联元素所做的更改的列表。选择每个条目以获取更多详细信息。

API 生成器变更日志