私有 API 网络
私有API 网络提供了你的团队在内部使用的工作空间、集合和 API 的中央目录。你的 Postman 团队可以访问这些资源并立即开始使用它们。通过使用私有 API 网络，你可以使整个组织的开发人员能够在一个地方发现、使用和跟踪 API 开发。
私有 API 网络中的工作空间、集合和 API 对你的 Postman 团队中的登录用户可见。不在你团队中的用户无法找到或访问这些资源。
作为质量控制措施，你的团队可以启用 可选的审批流程工作流 。批准工作流程确保只有具有 API 网络管理员角色 的指定团队成员才能将元素添加到你的私有 API 网络。如果你的团队不使用可选的批准流程工作流，任何对工作空间、集合或 API 具有编辑者角色的用户都可以将 其添加到私有 API 网络 。
浏览私有 API 网络
私有 API 网络是了解团队内共享的工作空间、集合和 API 的好地方。在你的团队名称下，你可以浏览团队内共享元素的目录。
有两种方法可以访问私有 API 网络：
- 从 Postman 标题中选择Home ，然后在左侧的团队信息中选择Private API Network 。
- 从 Postman header 中选择API Network ，然后选择**Private API Network**。
有多种方法可以在私有 API 网络中搜索、过滤和排序元素。
- 要按名称搜索，请在 Search elements中输入完整或部分元素名称。
- 要根据添加元素的人员进行过滤，请选择添加者，然后选择团队成员的姓名。
- 要按元素类型过滤，请选择Type，然后选择API、Collection或Workspace。
- 要对元素进行排序，请选择排序依据下拉列表。选项是：
- 最近添加- 按添加日期对元素进行排序。
- A 到 Z - 按字母顺序对元素进行排序。
- 本周趋势- 根据你团队本周的使用情况对元素进行排序。
- 本月趋势- 按团队本月的使用情况对元素进行排序。
要按字母顺序或按添加日期对文件夹、子文件夹和元素进行排序，请从边栏中选择排序图标 。
要查看有关元素的信息，请从列表中选择它。你可以查看元素的描述和处理它的编辑。对于工作空间，你可以查看其中的所有集合和 API。对于集合，你可以查看可用文档。对于 API，你可以查看定义和关联的集合。
要查看工作空间、集合或 API 并获得有关任何更改的通知，请选择右上角的“查看” 。
使用审批流程工作流
作为质量控制措施，你的团队可以启用 可选的审批流程工作流 。批准工作流程确保只有具有 API 网络管理员角色 的指定团队成员才能将元素添加到你的私有 API 网络。
要为你的团队使用此批准流程，你需要先完成两个步骤：
完成这些步骤后，具有元素编辑者角色的用户将需要请求 将 API 添加 到私有 API 网络。API 网络管理员将能够 审查 向私有 API 网络添加元素、 添加元素 以及 创建和编辑文件夹 的请求。
分配 API 网络管理员角色
API 网络管理员 可以：
- 将任何元素添加到团队的私有 API 网络
- 创建和编辑文件夹
- 将此角色分配给其他团队成员
你必须具有 超级管理员角色或 API 网络管理员角色 才能将此角色分配给用户。
要分配 API 网络管理员角色，请执行以下操作：
在“团队设置”页面上，选择“成员和组”。
选择要为其分配 API 网络管理员角色的用户。
在其名称旁边的Roles 下拉列表中，选择**API Network Manager，然后选择Update Roles**。有关将团队角色分配给单个用户的更多信息，请参阅 管理角色 。
企业团队也可以将此角色分配给用户组。有关将团队角色分配给组的更多信息，请参阅 管理用户组 。
Postman 将向新的 API 网络管理员发送一封电子邮件，告知他们更新后的角色。
开启审批流程
批准过程使 API 网络管理员能够控制将元素添加到其团队的私有 API 网络的过程。
你必须具有 超级管理员角色或 API 网络管理员角色 才能开启批准流程。
要打开审批流程工作流，请执行以下操作：
- 在 Postman 标题中，选择Team > Team Settings。
- 选择私有 API 网络。
- 开启审批流程。
开启批准流程后，任何具有元素编辑者角色的团队成员都可以 请求将其添加到私有 API 网络 。
编辑：请求添加一个元素
当你启用 可选的审批流程 时，具有元素编辑者角色的用户可以请求将其添加到私有 API 网络。
当你提交请求时，Postman 会通知 API 网络管理员 ，他将审核你的请求并批准或拒绝它。postman 将通知你 API 网络管理员的决定。如果他们拒绝你的请求，通知将包含一条说明其原因的评论。
请求添加工作空间
- 打开要添加到私有 API 网络的工作空间。
- 在工作空间概览中，选择请求添加到 API 网络。
- （可选）选择一个文件夹或创建一个文件夹以保持元素井井有条。
- （可选）选择添加评论为 API 网络管理器添加注释。
- 选择请求添加到 API 网络。
请求添加一个集合
- 打开要添加到私有 API 网络的集合。
- 选择信息图标
，然后选择请求添加到 API 网络。 - （可选）添加关于集合的简短摘要。
- （可选）选择“选择环境”以确保用户有权访问环境变量。
- （可选）选择一个文件夹或创建一个文件夹以保持元素井井有条。
- （可选）选择添加评论为 API 网络管理器添加注释。
- 选择请求添加到 API 网络。
请求添加 API
- 打开要添加到私有 API 网络的 API。
- 在 API 概述中，选择请求添加到 API 网络。
- （可选）选择一个文件夹或创建一个文件夹以保持元素井井有条。
- （可选）选择添加评论为 API 网络管理器添加注释。
- 选择请求添加到 API 网络。
API 网络管理器：审查添加元素的请求
当编辑器请求将元素添加到你团队的私有 API 网络时，Postman 会向你发送电子邮件和应用内通知。对于所有待处理请求的列表，打开 私有 API 网络 并选择Pending Requests。
待定请求包括提交请求的用户、他们提交请求的日期、查看元素的链接以及来自请求用户的可选注释。
要批准请求，请执行以下操作：
- 选择批准。
- （集合）（可选）编辑提供的摘要。
- （可选）选择一个文件夹或创建一个文件夹以保持元素井井有条。
- 选择批准请求。
要拒绝请求，请执行以下操作：
- 选择拒绝。
- 为提交请求的编辑写一条注释，详细说明你拒绝他们请求的原因。
- 选择拒绝请求。
向私有 API 网络添加元素
要将元素添加到私有 API 网络，它必须位于团队或公共工作空间的 API 构建器中。 你不能将元素添加到私有 API 网络，除非所有团队成员都至少具有对该元素的查看权限。详细了解团队 角色和权限 。
- 如果你的团队使用 可选的批准流程 ，则具有编辑角色的团队成员必须提交将元素添加到私有 API 网络的 请求，并且 API 网络管理员必须 批准该请求 。API 网络管理员可以直接向私有 API 网络添加元素。
- 如果你的团队不使用可选的批准流程，则任何具有元素编辑者角色的用户都可以将其添加到私有 API 网络。
你可以从 API Builder 和 Postman API 向私有 API 网络添加元素。
添加工作空间
如果你的团队使用 可选的批准流程 ，则只有 API 网络管理员可以将工作空间直接添加到私有 API 网络。工作空间编辑必须 请求添加工作空间 。如果你的团队不使用审批流程，则任何对工作空间具有编辑访问权限的用户都可以将其添加到私有 API 网络。
要从 API 构建器向私有 API 网络添加工作空间，请执行以下操作：
- 打开要添加到私有 API 网络的工作空间。
- 在工作空间概览中，选择添加到 API 网络。
- （可选）选择一个文件夹或创建一个文件夹以保持元素井井有条。
- 选择添加。
要从你团队的私有 API 网络中添加工作空间，请执行以下操作：
- 打开你的 私有 API 网络 。
- 选择添加到网络。
- 搜索并选择要添加的工作空间。
- （可选）选择一个文件夹或创建一个文件夹以保持元素井井有条。
- 选择添加。
当你将工作空间添加到 私有 API 网络 时，它对你的 Postman 团队可见，但对 合作伙伴 不可见。
添加集合
如果你的团队使用 可选的批准流程 ，则只有 API 网络管理员可以将集合直接添加到私有 API 网络。收藏编辑必须 请求添加一个收藏 。如果你的团队不使用审批流程，则任何对集合具有编辑访问权限的用户都可以将其添加到私有 API 网络。
要从 API Builder 将集合添加到私有 API 网络，请执行以下操作：
- 打开要添加到私有 API 网络的集合。
- 选择信息图标 ，然后选择添加到 API 网络。
- （可选）添加关于集合的简短摘要。
- （可选）选择“选择环境”以确保用户有权访问环境变量。
- （可选）选择一个文件夹或创建一个文件夹以保持元素井井有条。
- 选择添加。
要在你团队的私有 API 网络中添加集合，请执行以下操作：
- 打开你的 私有 API 网络 。
- 选择添加到网络
- 搜索并选择要添加的集合。
- （可选）选择一个文件夹或创建一个文件夹以保持元素井井有条。
- 选择添加。
当你将集合添加到 私有 API 网络 时，它对你的 Postman 团队可见，但对 合作伙伴 不可见。
你添加到私有 API 网络的集合反映了你团队工作空间中集合的最新状态。换句话说，对工作空间中的集合所做的更改会实时反映在网络中。
添加 API
如果你的团队使用 可选的批准流程 ，则只有 API 网络管理员可以将 API 直接添加到私有 API 网络。API 编辑者必须 请求添加 API 。如果你的团队不使用审批流程，则任何拥有 API 编辑访问权限的用户都可以将其添加到私有 API 网络。
要从 API Builder 将 API 添加到私有 API 网络，请执行以下操作：
- 打开要添加到私有 API 网络的 API。
- 在 API 概述中，选择Publish API。
- 选择请求添加到私有 API 网络。
- （可选）选择一个文件夹或创建一个文件夹以保持元素井井有条。
- 选择添加。
要在你团队的私有 API 网络中添加 API，请执行以下操作：
- 打开你的 私有 API 网络 。
- 选择添加到网络
- 搜索并选择要添加的 API。
- （可选）选择一个文件夹或创建一个文件夹以保持元素井井有条。
- 选择添加。
当你将 API 添加到 私有 API 网络 时，它对你的 Postman 团队可见，但对 合作伙伴 不可见。
你发布到私有 API 网络的 API 反映了你团队工作空间中 API 的最新状态。换句话说，对工作空间中的 API 所做的已发布更改会实时反映在网络中。
发布特定的 API 版本
发布一个版本会创建你的 API 的静态表示，消费者可以在私有 API 网络上查看。如果你的 API 连接到 Git 存储库，你需要发布 API 版本以使用最新更改更新你的团队工作空间。发布版本时，API 的定义和集合会同步到 Postman 云。
了解有关 发布 API 版本的 更多信息。
从代码库导入 API
从代码存储库导入所有现有 API 后，你可以在私有 API 网络上发现它们。了解有关 导入 API 的 更多信息。
管理私有 API 网络
将元素添加到私有 API 网络后，你可以通过在文件夹中组织它们、编辑它们的列表以及从私有 API 网络中删除它们来管理它们。
- 如果你的团队使用 可选批准流程 ，则具有 API 网络管理员的用户可以完成这些任务。
- 如果你的团队不使用可选批准流程，则任何具有编辑者角色的用户都可以完成这些任务。
你可以在私有 API 网络 中或使用 Postman API 管理元素。
用文件夹整理
侧边栏导航显示你的私有 API 网络的文件夹结构。你可以将元素和子文件夹拖到不同的文件夹中。你还可以向文件夹添加描述以描述文件夹中的元素。
要从私有 API 网络视图创建新文件夹，请执行以下操作：
- 从边栏中选择创建文件夹。
- 为文件夹命名。
- （可选）给出描述。
- 选择保存。
要从私有 API 网络概览页面创建新文件夹，请执行以下操作：
- 选择右侧的创建文件夹。
- 为文件夹命名。
- （可选）给出描述。
- 选择保存。
你还可以使用创建文件夹在文件夹内创建子文件夹。
使用搜索元素和文件夹搜索你的私有 API 网络中的文件夹、子文件夹和元素。
编辑元素列表
选择你要从网络中编辑的元素旁边的更多操作图标 ，然后选择编辑元素。你可以更改元素的摘要、位置和关联的环境。选择编辑以保存你的更改。
从私有 API 网络中删除元素
如果你的团队使用 可选的批准流程 ，则只有 API 网络管理员可以从私有 API 网络中删除元素。如果你的团队不使用审批流程，则任何对该元素具有编辑者角色的用户都可以删除它。
要从你的私有 API 网络中删除元素，请执行以下操作：
- 选择要从网络中删除的元素旁边的更多操作图标 。
选择删除。
删除元素后，团队成员将无法通过私有 API 网络访问它。
私有 API 网络报告
通过更深入地了解私有 API 网络中的 API，报告功能可以更轻松地管理内部 API 环境。
从 Postman 标题中选择 Home ，然后选择左侧的Reports 。
API 报告提供以下信息：
- API 名称是发布到 Private API Network 的 API 的名称
- API created by是创建 API 的人的名字
- API created on是创建 API 的日期
- API 请求数是一段时间内发送的 API 请求总数
- Failed test runs是一段时间内失败的测试运行次数
- 平均响应大小是报告期间请求的平均响应大小（以字节为单位）
- 平均响应时间是一个时间范围内请求的平均响应时间（以毫秒为单位）
- API 响应代码是一张图表，显示绘制的 API 请求的不同响应代码与 API 请求的数量
要了解有关报告的更多信息，请参阅 报告概述 。