开发 API

在 Postman API Builder 中，您可以通过将 API 链接到文档、环境和模拟服务器来开发您的 API。

当您添加文档、测试、模拟、监视器和环境时，选择下拉列表中只会列出当前工作空间中的元素。

• 添加文档
  • 创建新文档
  • 添加现有文档
• 添加环境
• 添加模拟服务器
  • 创建一个新的模拟服务器
  • 添加现有的模拟服务器
• 从 API 中删除元素

添加文档

您可以将集合生成的文档链接到 API 的特定版本。

创建新文档

要从您的架构创建新集合并生成 API 文档：

1. 在 API version Overview选项卡中，选择Documentation旁边的+并选择Create new documentation。

2. 指定名称，通过选择Show advanced settings配置应如何生成集合，然后选择Create Documentation。

添加现有文档

1. 在 API 版本概览选项卡中，选择文档旁边的+并选择添加现有文档。

2. 选择包含要链接的文档的集合，然后选择添加文档。您只会在列表中看到可用的集合。

查看文档

您可以在 API Builder 中查看您的 API 文档。选择文档标题下列出的任何文档以在新窗口中打开它。

您还可以在“文档”选项卡中查看文档。选项卡的左上角是一个下拉列表，您可以在其中选择显示哪个集合，并添加或生成另一个文档集合。

从“文档”选项卡中选择“查看集合”以查看文档的集合。

添加环境

您可以将工作区中的特定环境链接到 API 的特定版本。

1. 在 API 版本概览选项卡的Environments旁边，选择+。

2. 从列表中选择一个环境，然后选择添加环境。您只会在列表中看到可用的环境。

添加模拟服务器

您可以通过创建新的模拟服务器或添加现有的模拟服务器，将集合的模拟服务器链接到 API。

创建一个新的模拟服务器

1. 在 API 版本概览选项卡中，在Mock Servers旁边，选择+并选择Create new mock server。
2. 选择一个集合并配置模拟服务器，如中所述

从 API 创建模拟。

添加现有的模拟服务器

1. 在 API 版本概览选项卡中，在Mock Servers旁边，选择+并选择Add existing mock server。

2. 从您的工作区中选择一个模拟服务器，然后选择添加模拟服务器。您只会在列表中看到可用的模拟。您的模拟服务器将被添加到 API。

从 API 中删除元素

您可以从 API 中删除关联的文档集合、环境或模拟服务器集合。

在 API 版本概览选项卡中，将鼠标悬停在元素上并选择它的右侧。

这只会删除元素和 API 版本之间的关联。它不会删除该元素或将其从您的工作区中移除。