JSPM

  • Created
  • Published
  • Downloads 5331
  • Score
    100M100P100Q129221F
  • License MIT

Convert postman collection to OpenAPI spec

Package Exports

  • postman-to-openapi

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (postman-to-openapi) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

logo

postman-to-openapi

🛸 Convert Postman Collection v2.1/v2.0 to OpenAPI v3.0.

Or in other words, transform this specification and also this to this one

build codecov npm version docs

Installation

Using npm:

npm i postman-to-openapi

Using yarn:

yarn add postman-to-openapi

Quick Usage

// Require Package
const postmanToOpenApi = require('postman-to-openapi')

// Postman Collection Path
const postmanCollection = './path/to/postman/collection.json'
// Output OpenAPI Path
const outputFile = './api/collection.yml'

// Async/await
try {
    const result = await postmanToOpenApi(postmanCollection, outputFile, { defaultTag: 'General' })
    // Without save the result in a file
    const result2 = await postmanToOpenApi(postmanCollection, null, { defaultTag: 'General' })
    console.log(`OpenAPI specs: ${result}`)
} catch (err) {
    console.log(err)
}

// Promise callback style
postmanToOpenApi(postmanCollection, outputFile, { defaultTag: 'General' })
    .then(result => {
        console.log(`OpenAPI specs: ${result}`)
    })
    .catch(err => {
        console.log(err)
    })

Documentation

All features, usage instructions and help can be found in the Documentation page

Development

This project use for development:

Use the scripts in package.json:

  • test:unit: Run mocha unit test.
  • test: Execute test:lint plus code coverage.
  • lint: Execute standard lint to review errors in code.
  • lint:fix: Execute standard lint and automatically fix errors.
  • changelog: Update changelog automatically.

Husky is configured to avoid push incorrect content to git.

Tags

Nodejs Javascript OpenAPI Postman Newman Collection Transform Convert

License

See the LICENSE file.