跳到主要内容

向 API 添加元素

Postman 中的 API 可以包含多个 API 定义。你可以添加元素（例如集合）来帮助你记录和测试你的 API。

添加集合时，会将集合的独立副本添加到 API。API 中的副本将不再与原始副本同步。如果你移动或删除 API，则该 API 中包含的任何集合都会随之移动或删除。

添加一个集合​

添加一个集合来记录你的 API 或帮助其他人测试你的 API 的端点。你可以添加现有集合或根据 API 定义生成新集合。

你还可以向 API 添加测试套件。了解有关 测试 API 的 更多信息。

添加新集合​

要向你的 API 添加新集合，请执行以下操作：

  1. 在边栏中选择API ，然后选择一个 API。
  2. 在 API 的概述中，在 Collections旁边，选择+并选择Add new collection。
  3. 输入集合的新名称。

添加现有集合​

要将现有集合添加到你的 API，请执行以下操作：

  1. 在边栏中选择API ，然后选择一个 API。
  2. 在 API 的概述中，在Collections旁边，选择+并选择Copy existing collection。
  3. 选择一个可用的集合并选择复制集合。

集合的副本显示在你的 API 概览和侧边栏中的 API 下方。要查看集合的文档，请展开集合并选择查看完整的集合文档。

生成集合​

要从你的 API 定义生成新集合，请执行以下操作：

  1. 在边栏中选择API ，然后选择一个 API。
  2. 在 API 的概述中，在Collections旁边，选择+并选择Generate from definition。
  3. 如果你希望 Postman 在 API 定义更改时建议更新集合，请选中该复选框。默认情况下选中此复选框。了解有关 使集合与 API 保持同步的 更多信息。
  4. 更改任何设置以自定义新集合。
  5. 选择生成集合。

该集合显示在你的 API 概览和侧边栏中的 API 下方。要查看集合的文档，请展开集合并选择查看完整的集合文档。

你还可以在导入 API 时生成一个集合。有关详细信息，请参阅 导入 API 。

使集合与 API 保持同步​

当你从 API 定义 生成集合 时，Postman 会创建一个集合，其中包含与 API 中定义的内容相匹配的请求。如果你更新 API 定义，例如通过添加路径，这些更改将不会反映在生成的集合中。

在这种情况下，你可以重复从 API 定义生成集合的过程。但是，这个新集合不会包含你可能对生成的第一个集合所做的任何更改。例如，你可能已经为要保留的测试设置添加了文档内容或端点。相反，Postman 可以根据 API 定义的更改提供更新集合的建议。

启用集合更新建议​

你可以为已添加到 API 的任何集合启用更新建议。启用建议后，Postman 将检测 API 定义和集合之间何时存在差异，并提供更新集合的建议。

要为集合启用更新建议，请执行以下操作：

  1. 在边栏中选择API ，然后选择一个 API。
  2. 在 API 的概览中，选择 更多操作图标 集合旁边的更多操作图标，然后选择Enable update suggestions from definition。

如果要关闭建议，请选择 更多操作图标 集合旁边的更多操作图标，然后选择Disable update suggestions from definition。

根据 API 定义更新集合​

启用建议后， 更新收藏图标 如果 Postman 检测到集合与 API 定义之间存在差异，则更新集合图标会出现在集合旁边。如果更改 API 定义，例如通过添加、删除或修改端点，则可能会出现差异。如果在集合中添加、删除或修改请求，也会出现差异。你可以查看差异，如果你愿意，可以使用建议的更改更新集合。

要根据 API 定义更新集合，请执行以下操作：

  1. 更新收藏图标 选择 API 概述中集合旁边的更新集合图标 。

    更新收藏图标

  2. 查看对集合的建议更新：

    • 添加请求- 这些请求将根据在 API 定义中找到的路径添加到集合中。选择请求旁边的箭头以获取更多详细信息。
    • 修改请求- 这些请求将被更新以匹配 API 定义中的路径。选择请求旁边的箭头以获取更多详细信息。
    • 删除请求- 这些请求与 API 定义中的任何路径都不匹配。如果你想要将请求从集合中删除，请选中请求旁边的复选框。如果你想将请求保留在集合中，请清除请求旁边的复选框。

  3. 当你准备好对集合进行建议的更新时，请选择更新集合。

查看集合更新建议

Forking 一个集合​

添加到 API 的集合不能与监视器、模拟服务器或 CI 集成一起使用。要在具有这些功能的 API 中使用集合，你必须 Forking 该集合。

要从 API 派生集合，请执行以下操作：

  1. 在边栏中选择API ，然后选择一个 API。
  2. 在边栏中选择集合。
  3. Forking图标 选择右上角的 Forking 图标 。

详细了解 Postman 中的 Forking 元素 。

从 API 中删除元素​

要从 API 中删除集合，请执行以下操作：

  1. 在边栏中选择API ，然后选择一个 API。
  2. 更多操作图标 在边栏中，选择集合旁边的更多操作图标 ，然后选择删除。

你还可以从 API 的概览中删除集合。更多操作图标 选择集合旁边的更多操作图标 ，然后选择删除。