管理和共享 API
当您使用 API Builder 在 Postman 中定义 API时,每个 API 都与一个工作区相关联。您可以共享对 API 的访问权限、在评论中讨论它们并查看架构活动。
共享 API
您可以通过导航到左侧边栏中要共享的 API 与协作者共享您的 API。选择它,然后选择>共享。
![分享api](https://assets.postman.com/postman-docs/share-api-9.4.jpg)
有关更多详细信息,请参阅共享 Postman 实体。
在 API 上进行协作
您可以将 API 移动到共享工作区以与您的团队协作。
您必须是 API 的编辑者或工作区管理员才能将 API 移动到另一个工作区。
在左侧边栏中导航到您要共享的 API,选择它,然后选择>移动。
使用搜索栏查找要将 API 移动到的工作区,或通过选择搜索栏右侧的图标按工作区可见性进行过滤。
您可以将 API 共享到您有权访问的个人、私人、团队和公共工作区。共享的私人、团队和公共工作区允许您与他人协作。
您不能将 API 从团队、私人或公共工作区移动到个人工作区。
有关团队内工作区访问控制的信息,请参阅角色和权限。
选择工作区,然后选择Move API。
![移动 API](https://assets.postman.com/postman-docs/move-api-v9.1.jpg)
请注意,API 的集合、文档、监视器、模拟服务器和环境不会随 API 自动移动到新工作区。
集合和环境必须分开移动。必须在新工作区中重新配置文档、监视器和模拟服务器。
观看 API
当属于同一工作区的团队成员修改 API(例如更新架构、将元素附加到 API、向 API 添加评论等)时,监视选项使您能够接收电子邮件或应用内通知。
选择Watch开始观看 API。
![观看选项](https://assets.postman.com/postman-docs/watch-button-v9.jpg)
选择右上角的铃铛图标以查看通知。弹出窗口将指示有关对 API 所做更改的更多信息。
您还将收到一封电子邮件,其中包含有关谁进行了更改、更改内容以及更改时间的信息。
您将不会收到有关您自己所做更改的通知。
评论 API
您可以在 Postman 中与合作者讨论您的 API,将对话保持在上下文中并可供其他利益相关者使用。任何有权访问 API 的人都可以发表评论。
要对 API 发表评论,请在左侧边栏中打开API,然后选择要评论的 API 版本。切换到评论模式,输入您的评论,然后添加评论以发布它。
通过突出显示要评论的内容,您可以在 API 架构上留下内联评论。
格式化评论
您可以在评论中使用 Markdown——查看Github 上的 Markdown 备忘单以获取有关格式化的提示。
如果您想在评论中引起合作者的注意,您可以通过键入@
后跟他们的姓名来标记他们——从自动建议的列表中选择此人。当您在评论中标记成员时,邮递员会向他们发送通知。
编辑、删除或链接到评论
要编辑、删除或链接到您的评论之一,请导航到评论部分并将鼠标悬停在您要管理的评论上。选择钢笔图标来编辑评论,选择垃圾桶图标
来删除,或者选择锚图标
来获得评论的直接链接。
使用管理员权限,您可以删除任何贡献者发表的评论,但不能更新或修改评论。
使用变更日志
您可以在上下文栏中查看 API 架构和所有链接集合的更改日志。您还可以从变更日志中创建 API 版本。
要查看更改日志,请打开 API 版本,然后选择更改日志图标。
您将看到对架构和相关元素所做的更改列表。显示每个版本,列表顶部将显示任何未发布的更改。选择每个条目以查看更多详细信息。
选择列表顶部的+ 发布更改以从未发布的更改创建发布。有关更多信息,请参阅使用 API 版本。
![变更日志](https://assets.postman.com/postman-docs/api-builder-changelog-v9.jpg)
下一步
有关在 Postman 中使用 API Builder 的更多信息,请查看以下资源: