# @paloaltonetworks/openapi-to-postmanv2 > Convert a given OpenAPI specification to Postman Collection v2.0 Latest version **3.1.0-hotfix.5** (published 2022-07-06) · Apache-2.0 license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install @paloaltonetworks/openapi-to-postmanv2 pnpm add @paloaltonetworks/openapi-to-postmanv2 yarn add @paloaltonetworks/openapi-to-postmanv2 bun add @paloaltonetworks/openapi-to-postmanv2 ``` Provides the command `openapi2postmanv2`. ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 3.1.0-hotfix.5 | | Published | 2022-07-06 | | First published | 2022-03-24 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Node | >=8 | | Dependencies | 12 | | Unpacked size | 6.9 MB | | Known vulnerabilities | 0 (+11 in 5 direct dependencies) | | Install scripts | no | | GitHub stars | 4 | | Author | Postman Labs | | Maintainers | sserrata, csestito, btorresgil, xhoms | | Keywords | openapi, postman, api, schema, swagger, oas | ## Links - npm: https://www.npmjs.com/package/@paloaltonetworks/openapi-to-postmanv2 - Repository: https://github.com/PaloAltoNetworks/openapi-to-postman - Issues: https://github.com/PaloAltoNetworks/openapi-to-postman/issues - npm.io page: https://npm.io/package/@paloaltonetworks/openapi-to-postmanv2 ## Dependencies (12) - [ajv](https://npm.io/package/ajv.md) 8.1.0 - [yaml](https://npm.io/package/yaml.md) 1.10.2 - [async](https://npm.io/package/async.md) 3.2.1 - [lodash](https://npm.io/package/lodash.md) 4.17.21 - [flatted](https://npm.io/package/flatted.md) ^3.2.6 - [js-yaml](https://npm.io/package/js-yaml.md) 3.14.1 - [commander](https://npm.io/package/commander.md) 2.20.3 - [ajv-formats](https://npm.io/package/ajv-formats.md) 2.1.1 - [path-browserify](https://npm.io/package/path-browserify.md) 1.0.1 - [oas-resolver-browser](https://npm.io/package/oas-resolver-browser.md) 2.5.2 - [json-schema-merge-allof](https://npm.io/package/json-schema-merge-allof.md) 0.8.1 - [@paloaltonetworks/postman-collection](https://npm.io/package/@paloaltonetworks/postman-collection.md) ^4.1.0 ## Alternatives - [update-check](https://npm.io/package/update-check.md) — 4.0M weekly downloads - [react-native-onesignal](https://npm.io/package/react-native-onesignal.md) — 134.5K weekly downloads - [react-redux-toastr](https://npm.io/package/react-redux-toastr.md) — 33.7K weekly downloads - [@nocobase/plugin-notification-manager](https://npm.io/package/@nocobase/plugin-notification-manager.md) — 2.0K weekly downloads - [react-simple-toasts](https://npm.io/package/react-simple-toasts.md) — 1.9K weekly downloads ## Recent versions - 3.1.0-hotfix.5 (latest) — 2022-07-06 - 3.1.0-hotfix.4 — 2022-04-05 - 3.1.0-hotfix.3 — 2022-04-05 - 3.1.0-hotfix.2 — 2022-03-30 - 3.1.0-hotfix.1 — 2022-03-24 - 3.1.0 — 2022-03-24 ## README ![postman icon](https://raw.githubusercontent.com/postmanlabs/postmanlabs.github.io/develop/global-artefacts/postman-logo%2Btext-320x132.png) *Supercharge your API workflow.* *Modern software is built on APIs. Postman helps you develop APIs faster.* # OpenAPI 3.0 to Postman Collection v2.1.0 Converter [![Build Status](https://travis-ci.org/postmanlabs/openapi-to-postman.svg?branch=master)](https://travis-ci.org/postmanlabs/openapi-to-postman) ![npm](https://img.shields.io/npm/v/openapi-to-postmanv2.svg) ![npm](https://img.shields.io/npm/dw/openapi-to-postmanv2.svg) #### Contents 1. [Getting Started](#getting-started) 2. [Using the converter as a NodeJS module](#using-the-converter-as-a-nodejs-module) 1. [Convert Function](#convert) 2. [Options](#options) 3. [ConversionResult](#conversionresult) 4. [Sample usage](#sample-usage) 5. [Validate function](#validate-function) 3. [Command Line Interface](#command-line-interface) 1. [Options](#options) 2. [Usage](#usage) 4. [Conversion Schema](#conversion-schema) --- ## 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. ```terminal $ npm install openapi-to-postmanv2 ``` If you want to use the converter in the CLI, install it globally with NPM: ```terminal $ npm i -g openapi-to-postmanv2 ``` ## 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`. ```javascript var Converter = require('openapi-to-postmanv2') ``` The converter provides the following functions: ### Convert The convert function takes in your OpenAPI specification ( YAML / JSON ) and converts it to a Postman collection. Signature: `convert (data, options, callback);` **data:** ```javascript { type: 'file', data: 'filepath' } OR { type: 'string', data: '' } OR { type: 'json', data: OpenAPI-JS-object } ``` **options:** ```javascript { schemaFaker: true, requestNameSource: 'fallback', indentCharacter: ' ' } /* All three properties are optional. Check the options section below for possible values for each option. */ ``` **callback:** ```javascript function (err, result) { /* result = { result: true, output: [ { type: 'collection', data: {..collection object..} } ] } */ } ``` ### Options: Check out complete list of options and their usage at [OPTIONS.md](/OPTIONS.md) ### ConversionResult - `result` - Flag responsible for providing a status whether the conversion was successful or not - `reason` - Provides the reason for an unsuccessful conversion, defined only if result: false - `output` - Contains an array of Postman objects, each one with a `type` and `data`. The only type currently supported is `collection`. ### Sample Usage: ```javascript var fs = require('fs'), Converter = require('openapi-to-postmanv2'), openapiData = fs.readFileSync('sample-spec.yaml', {encoding: 'UTF8'}); Converter.convert({ type: 'string', data: openapiData }, {}, (err, conversionResult) => { if (!conversionResult.result) { console.log('Could not convert', conversionResult.reason); } else { console.log('The collection object is: ', conversionResult.output[0].data); } } ); ``` ### Validate Function The validate function is meant to ensure that the data that is being passed to the [convert function](#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 #### Validation object schema ```javascript { type: 'object', properties: { result: { type: 'boolean'}, reason: { type: 'string' } }, required: ['result'] } ``` ##### Validation object explanation - `result` - true if the data looks like OpenAPI and can be passed to the convert function - `reason` - Provides a reason for an unsuccessful validation of the specification ## Command Line Interface The converter can be used as a CLI tool as well. The following [command line options](#options) are available. `openapi2postmanv2 [options]` ### Options - `-v`, `--version` Specifies the version of the converter - `-s `, `--spec ` Used to specify the OpenAPI specification (file path) which is to be converted - `-o `, `--output ` Used to specify the destination file in which the collection is to be written - `-t`, `--test` Used to test the collection with an in-built sample specification - `-p`, `--pretty` Used to pretty print the collection object while writing to a file - `-O`, `--options` Used to supply options to the converter, for complete options details see [here](/OPTIONS.md) - `-c`, `--options-config` Used to supply options to the converter through config file, for complete options details see [here](/OPTIONS.md) - `-h`, `--help` Specifies all the options along with a few usage examples on the terminal ### Usage **Sample usage examples of the converter CLI** - Takes a specification (spec.yaml) as an input and writes to a file (collection.json) with pretty printing and using provided options ```terminal $ openapi2postmanv2 -s spec.yaml -o collection.json -p -O folderStrategy=Tags,includeAuthInfoInExample=false ``` - Takes a specification (spec.yaml) as an input and writes to a file (collection.json) with pretty printing and using provided options via config file ```terminal $ openapi2postmanv2 -s spec.yaml -o collection.json -p -c ./examples/cli-options-config.json ``` - 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 `""` kind of errors present in converted collection) ```terminal $ openapi2postmanv2 -s spec.yaml -o collection.json -p -O folderStrategy=Tags,requestParametersResolution=Example,optimizeConversion=false,stackLimit=50 ``` - Testing the converter ```terminal $ openapi2postmanv2 --test ``` ## Conversion Schema | *postman* | *openapi* | *options* | *examples* | | --- | --- | :---: | :--- | | collectionName | info.title | - | | | description | info.description + info.contact | - | | | collectionVariables| server.variables + pathVariables | - | | | folderName | paths.path | - | | | requestName | operationItem(method).operationId | default(operationId)-(`requestName`)enum['operationId','summary','url'] | | | request.method | path.method | - | | | request.headers | parameter (`in = header`) | - | [link](#Header/Path-param-conversion-example) | | request.body | operationItem(method).requestBody | - | | | request.url.raw | server.url (path level server >> openapi server) + path | - | | | request.url.variables | parameter (`in = path`) | - | [link](#Header/Path-param-conversion-example) | | request.url.params | parameter (`in = query`) | - | {"key": param.name, "value": [link](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#style-examples)}| | api_key in (query or header) | components.securitySchemes.api_key | - || --- _Source: https://npm.io/package/@paloaltonetworks/openapi-to-postmanv2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._