Skip to content
Javascript module that allows a developer to work with Postman Collections
JavaScript
Branch: develop
Clone or download
codenirvana Merge pull request #961 from coditva/codecov
Replace istanbul with nyc and add codecov
Latest commit 65a78b6 Dec 13, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.ci adding encrypted key Mar 22, 2016
benchmark Fixed lint errors May 30, 2019
docs Add detailed docs on mutation tracking Sep 24, 2018
examples Add tests for protocolProfileBehavior on item-group Dec 4, 2018
lib Accept Response.stream to be a Base64 string Dec 2, 2019
npm Replace istanbul with nyc and add codecov Dec 12, 2019
test Replace istanbul with nyc and add codecov Dec 12, 2019
.editorconfig Initial commit with code migrated from proof-of-concept stage Feb 23, 2016
.eslintrc Removed noisy eslint rule of consistent-return which we have outgrown… Mar 18, 2019
.gitattributes add .gitattributes Nov 1, 2018
.gitignore Add npm and vscode to npmignore Nov 7, 2017
.jsdoc-config.json updated documentation theme Jun 3, 2016
.npmignore Add npm and vscode to npmignore Nov 7, 2017
.travis.yml Replace istanbul with nyc and add codecov Dec 12, 2019
CHANGELOG.yaml Add changelog for coverage Dec 12, 2019
CONTRIBUTING.md Initial commit with code migrated from proof-of-concept stage Feb 23, 2016
LICENSE.md Initial commit with code migrated from proof-of-concept stage Feb 23, 2016
README.md Update README with Travis and Codecov badges Dec 13, 2019
codecov.yml Replace istanbul with nyc and add codecov Dec 12, 2019
index.js Initial commit with code migrated from proof-of-concept stage Feb 23, 2016
package-lock.json Replace istanbul with nyc and add codecov Dec 12, 2019
package.json Replace istanbul with nyc and add codecov Dec 12, 2019

README.md

Postman Collection SDK Build Status codecov

Postman Collection SDK is a NodeJS module that allows a developer to work with Postman Collections. Using this module a developer can create collections, manipulate them and then export them in a format that the Postman Apps and Postman CLI Runtimes (such as Newman) can consume.

A collection lets you group individual requests together. These requests can be further organized into folders to accurately mirror your API. Requests can also store sample responses when saved in a collection. You can add metadata like name and description too so that all the information that a developer needs to use your API is available easily.

To know more about Postman Collections, visit the collection documentation section on Postman Website.

The new Collection Format v2 builds a stronger foundation for improving your productivity while working with APIs. We want your feedback and iron out issues before this goes into the Postman Apps.

Installing the SDK

Postman Collection SDK can be installed using NPM or directly from the git repository within your NodeJS projects. If installing from NPM, the following command installs the SDK and saves in your package.json

> npm install postman-collection --save

Getting Started

In this example snippet we will get started by loading a collection from a file and output the same in console.

var fs = require('fs'), // needed to read JSON file from disk
	Collection = require('postman-collection').Collection,
	myCollection;

// Load a collection to memory from a JSON file on disk (say, sample-collection.json)
myCollection = new Collection(JSON.parse(fs.readFileSync('sample-collection.json').toString()));

// log items at root level of the collection
console.log(myCollection.toJSON());

After loading the collection from file, one can do a lot more using the functions that are available in the SDK. To know more about these functions, head over to Collection SDK Docs.

Postman Collection Schema

The collection schema outlines the JSON definition of data structure accepted by the constructor of each properties of this SDK. In other words, this SDK provides JavaScript level object manipulation for the JSON structure defined by Postman Collection Format in http://schema.getpostman.com/.

Schema Version Compatible SDK Versions
1.0 none
2.0 <3.0
2.1 >= 3.0

Conceptually, a JSON input to the constructor of an SDK property should provide similar output when that property instance's .toJSON() is called.

You can’t perform that action at this time.