跳到主要内容

Collection SDK

Collection SDK 是一个 Node.js 模块，允许你使用 Postman Collections 并将它们动态构建到你的 API 项目管道中。

使用 Collection SDK，你可以创建和操作集合，将它们导出为一种格式，然后你可以将其与其他实用程序集成，包括 Postman 和 Newman ，Postman 的命令行集合运行器。

接入采集 SDK​

Collection SDK 是一个开源项目。有关在你自己的项目中使用该模块的更多详细信息， 请访问存储库。 SDK 文档 提供了 SDK 中可用对象和方法的概述，以及相关 概念 的介绍。

你可以从 npm 或直接从存储库安装 SDK 。以下摘录演示了使用 SDK 读取文件并将其解析为 JavaScript 中的集合对象：

var fs = require('fs'),
  Collection = require('postman-collection').Collection,
  myCollection;

myCollection = new Collection(JSON.parse
  (fs.readFileSync('sample-collection.json').toString()));

console.log(myCollection.toJSON());

Collection SDK 提供了一个接口，用于处理由 Postman Collection Schema 定义的数据结构。你可以使用 SDK 方法来创建和操作集合元素、定义请求详细信息、变量、身份验证等。

从项目 repo 开始使用 Collection SDK ，安装它并使用适合你的开发或测试项目的方式构建集合的方法。你还可以 Forking 并为项目做出贡献，或者为任何问题或功能请求创建问题。

下一步​

如果你正在使用 Collection SDK 来自动化你的部分 collection run 工作流程，你可以将你的 Collection SDK 开发与 Postman 的命令行 collection run 器 Newman 集成：