您的私有 API 网络

您可以将团队内部使用的 API 共享到专用 API 网络。您的团队可以了解和访问这些 API，并立即开始使用它们。

要将 API 添加到团队的私有 API 网络，它必须位于API Builder中。您只能将 API 而不是集合添加到私有 API 网络。

内容

• 添加您的 API
  • 安全
  • 指导方针
• 私有 API 网络的特点
  • 文件夹组织
  • API 概览页面
  • API 版本
  • 轻松过滤
  • API 格局治理
  • GitHub 导入
• 发现和使用私有 API
• 下一步

添加您的 API

如果您对 API 具有编辑权限，并且您的团队成员有权查看或编辑 API，则您只能将 API 添加到网络。了解有关角色和权限的更多信息。

要从Postman将 API 添加到团队的私有 API 网络，请登录并在左侧导航栏中选择私有 API 网络。

默认视图是您团队的Private API Network。要将 API 添加到团队的私有 API 网络，请在左侧导航栏中选择Add APIs。

一次选择一个或多个要添加到网络的 API。如果需要，创建一个文件夹以将 API 添加到其中。选择添加 API。

您添加到专用 API 网络的 API 反映了团队工作区中 API 的最新状态。换句话说，对工作空间中的 API 所做的更改将实时反映在网络中。

该 API 将立即在您团队的Private API Network中可见。从列表中，您可以编辑网络列表或从网络中删除 API。

您还可以通过左侧导航栏中的 API 从 API Builder 将 API 添加到团队的私有API网络。选择一个 API 以在概览选项卡上查看高级描述。选择概览页面右上角的将API 添加到私有 API 网络。

了解有关编辑和版本控制 API的更多信息。

安全

私有 API 仅对属于 Postman 团队的登录用户可见。不属于您团队的任何人都无法发现或访问它们。

指导方针

要将 API 添加到网络，您必须具有 API 的编辑权限，并且 API 必须位于团队或公共工作区中。除非所有团队成员都至少具有 API 的查看权限，否则您无法将 API 添加到专用网络。了解有关团队角色和权限的更多信息。

私有 API 网络的特点

私有 API 网络提供组织中所有内部 API 的中央目录，团队可以在设计自己的解决方案之前检查该目录。

下面列出了私有 API 网络的主要特性，这些特性有助于更轻松地发现私有 API：

文件夹组织

您可以从私有 API 网络视图创建新文件夹。从左侧导航栏中选择创建文件夹以创建新文件夹。给它一个名字和摘要（支持 Markdown）。您的新文件夹现在将在私有 API 网络中创建。

在概览页面中，选择右侧的创建文件夹以创建新文件夹。当您在文件夹中时，您还可以使用创建文件夹按钮创建子文件夹。

创建文件夹后，您可以添加 API 以开始使用。从选择 API下的下拉列表中选择您的 API ，以将它们添加到您团队的私有 API 网络。您可以一次选择要添加到私有 API 网络的任意数量的 API。选择添加 API。

消费者可见的所有版本都将在私有 API 网络上可用。阅读有关API 版本控制的更多信息。

选择您要从网络中编辑的 API 旁边，然后选择编辑 API 列表。您可以更新 API 摘要，并修改应添加 API 的文件夹。更改完成后选择更新。

您还可以从私有 API 网络中删除添加的 API。选择您要从网络中删除的 API 旁边的选项。选择Remove后，您的团队成员也将无法通过网络访问 API。

侧边栏导航显示私有 API 网络的文件夹结构。您还可以将 API 和子文件夹拖放到不同的文件夹中。此外，如果需要，您可以向文件夹添加支持 Markdown 的描述，以解释文件夹中的 API。

您可以使用搜索框搜索私有 API 网络中的文件夹、子文件夹和 API。

API 概览页面

API 概览页面提供有关 API 的所有相关信息，以使用户能够选择使用 API。这还提供了有关谁发布了此 API 以及该 API 的其他编辑者的信息，您可以使用Postman 中的评论与他们联系。

选择 API 以查找有关它的更多信息，包括 API 描述、Markdown 摘要、API 版本、API 当前所在的工作区、API 编辑器和 API 报告。您可以随时观看或取消观看 API。

API 版本

您可以将 API 的特定版本发布到私有 API 网络，这有助于 API 消费者了解哪些版本可供使用，哪些版本仍在处理中。只有供消费者使用的 API 版本在私有 API 网络上可见。

在 API 构建器中，您可以创建现有 API 的新版本。选择共享按钮附近的右侧，然后选择创建版本。您可以取消选中该复选框以隐藏版本或使其对消费者不可用。

您始终可以决定对消费者可见的 API 版本的可见性。要编辑 API 版本，请在概览选项卡中选择版本，然后在右上角选择>编辑。您可以选中该复选框以使该特定版本可供消费者使用。完成后选择保存更改。

当您将 API 版本发布到私有 API 网络时，只会发布消费者可见的版本，并且您可以随时恢复正在进行的 API 版本。

要了解有关 API 版本可见性的更多信息，请参阅版本控制 API。

轻松过滤

您可以使用搜索框根据名称过滤私有 API 网络中的 API。使用添加者菜单根据添加 API 的人进行筛选。使用排序依据选项根据名称和最近添加的 API 对 API 进行排序。

您还可以根据名称和最近添加的内容过滤文件夹、子文件夹和 API。

API 格局治理

通过更深入地了解私有 API 网络中的 API，报告功能可以更轻松地管理内部 API 环境。

报告仅适用于 Postman Enterprise 计划。

导航到您的 API 并选择 API右侧的报告。

API 报告提供以下信息：

• API 名称是发布到私有 API 网络的 API 的名称
• API created by是创建 API 的人的姓名
• API created on是 API 的创建日期
• API 请求数是一段时间内发送的 API 请求总数
• 失败的测试运行是在一个时间范围内失败的测试运行的数量
• 平均响应大小是一段时间内请求的平均响应大小（以字节为单位）
• 平均响应时间是在一个时间范围内请求的平均响应时间（以毫秒为单位）
• API 响应代码是一个图表，显示 API 请求的不同响应代码与 API 请求数量的关系

GitHub 导入

当您从 GitHub 导入时，您可以在私有 API 网络上发现所有现有 API。创建 API 时，切换到导入选项卡以查看从代码存储库导入的选项。

要从 Github导入，请参阅通过 GitHub 存储库导入。

发现和使用私有 API

私有 API 网络是了解团队内共享 API 的好地方。您可以在您的团队名称下浏览私有API 网络中的私有 API，或探索公共API 网络中的公共 API。

私有 API 仅对属于 Postman 团队的登录用户可见。

在您的团队名称下，您可以浏览团队内共享的 API 目录。选择一个 API 以查看高级描述。

要查看版本级别的详细信息，请选择API 版本右侧的> 。您可以查看有关 API 和描述的信息。您可以直接编辑架构或更改 API。您可以查看使用过 API 的编辑者以及它当前所在的工作区。

如果您尚未将 API添加到私有网络，则将 API 添加到私有 API 网络将显示在右侧。

选择Watch开始观看 API。要了解有关观看通知的更多信息，请参阅观看 API。

下一步

• 编写 API 文档
• 从 API 生成集合