An API-first entry in TopGit's GitHub warehouse: postmanlabs/openapi-to-postman, 1.1k stars, API, JavaScript. Plugin for converting OpenAPI 3.0 specs to the Postman Collection (v2) format
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Supercharge your API workflow.Modern software is built on APIs. Postman helps you develop APIs faster.
OpenAPI 3.0, 3.1 and Swagger 2.0 to Postman Collection
Contents
Getting Started
Command Line Interface
Options
Usage
Syncing Collections
Using the converter as a NodeJS module
Convert Function
Sync Collection Function
Options
ConversionResult
Sample usage
Validate function
Conversion Schema
🚀 We now also support OpenAPI 3.1 and Swagger 2.0 along with OpenAPI 3.0.
💭 Getting Started
To use the converter as a Node module, you need to have a copy of the NodeJS runtime. The easiest way to do this is through npm. If you have NodeJS installed you have npm installed as well.
$ npm install openapi-to-postmanv2
If you want to use the converter in the CLI, install it globally with NPM:
$ npm i -g openapi-to-postmanv2
📖 Command Line Interface
The converter can be used as a CLI tool as well. The following command line options are available.
openapi2postmanv2 [options]
Options
-s <source>, --spec <source>
Used to specify the OpenAPI specification (file path) which is to be converted
-o <destination>, --output <destination>
Used to specify the destination file in which the collection is to be written
-p, --pretty
Used to pretty print the collection object while writing to a file
-i, --interface-version
Specifies the interface version of the converter to be used. Value can be 'v2' or 'v1'. Default is 'v2'.
-O, --options
Used to supply options to the converter, for complete options details see here
-c, --options-config
Used to supply options to the converter through config file, for complete options details see here
-t, --test
Used to test the collection with an in-built sample specification
-v, --version
Specifies the version of the converter
-h, --help
Specifies all the options along with a few usage examples on the terminal
--sync <collectionFile>
Sync spec changes with an existing Postman Collection file
--sync-options <syncOptions>
Comma-separated list of sync options (e.g., syncExamples=true)
Takes a specification (spec.yaml) as an input and writes to a file (collection.json) with pretty printing and using provided options (Also avoids any "<Error: Too many levels of nesting to fake this schema>" kind of errors present in converted collection)
Whether to sync response examples from the OpenAPI specification to the collection. When enabled, response examples in the spec are synced with existing collection responses.
deleteOrphanedRequests
boolean
false
Whether to delete requests and folders that exist in the collection but no longer exist in the OpenAPI specification. When disabled (default), such orphans are preserved to avoid unintentional data loss.
For a complete list of sync options and their usage, see SYNC_OPTIONS.md
🛠 Using the converter as a NodeJS module
In order to use the convert in your node application, you need to import the package using require.
var Converter = require('openapi-to-postmanv2')
The converter provides the following functions:
Convert
The convert function takes in your OpenAPI 3.0, 3.1 and Swagger 2.0 specification (YAML / JSON) and converts it to a Postman collection.
Signature: convert (data, options, callback);
data:
{ type: 'file', data: 'filepath' }
OR
{ type: 'string', data: '<entire OpenAPI string - JSON or YAML>' }
OR
{ type: 'json', data: OpenAPI-JS-object }
options:
{
schemaFaker: true,
requestNameSource: 'fallback',
indentCharacter: ' '
}
/*
All three properties are optional. Check the options section below for possible values for each option.
*/
Note: All possible values of options and their usage can be found over here: OPTIONS.md
The validate function is meant to ensure that the data that is being passed to the convert function is a valid JSON object or a valid (YAML/JSON) string.
The validate function is synchronous and returns a status object which conforms to the following schema
Does postmanlabs/openapi-to-postman have a project website?
No homepage URL was recorded for postmanlabs/openapi-to-postman in TopGit's last sync. The README tab above frequently contains screenshots and demo links, or check the repository description on GitHub.
Is postmanlabs/openapi-to-postman open source?
Yes — postmanlabs/openapi-to-postman ships under the Apache-2.0 license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/postmanlabs/openapi-to-postman.
What else is in the API space?
postmanlabs/openapi-to-postman is tracked by TopGit under the API category, alongside 3 GitHub-tagged topics. Trending and Topics pages list peer repositories of comparable stars and language.
What is postmanlabs/openapi-to-postman?
postmanlabs/openapi-to-postman (postmanlabs/openapi-to-postman) is a JavaScript project on GitHub. From the project's own README: Plugin for converting OpenAPI 3.0 specs to the Postman Collection (v2) format
What license does postmanlabs/openapi-to-postman use?
postmanlabs/openapi-to-postman is released under the Apache-2.0 license. Always verify the LICENSE file directly on GitHub for the authoritative terms — license strings can be edited out of sync with a project's actual stance.
Where do I read more about postmanlabs/openapi-to-postman?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/postmanlabs/openapi-to-postman is the definitive source.
Why is postmanlabs/openapi-to-postman categorized under API?
TopGit places postmanlabs/openapi-to-postman in the API category based on its GitHub topics and description (tagged: "openapi", "openapi3", "postman-collection"). Categories are assigned from real repository metadata, not editorial guesswork.
Read full README in the tab above.
Still deciding about openapi-to-postman?
One click hands the question to an AI along with this page — see what it says about openapi-to-postman.