@readme/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

Installation

Using npm:

1npm i @readme/postman-to-openapi

Using yarn:

1yarn add @readme/postman-to-openapi

Quick Usage

As a library

1const postmanToOpenAPI = require('postman-to-openapi')
2
3// Postman collection
4const postmanCollection = './path/to/postman/collection.json'
5// Output OpenAPI Path
6const outputFile = './api/collection.yml'
7
8postmanToOpenAPI(postmanCollection, outputFile, { defaultTag: 'General' })
9  .then(result => {
10    console.log(`OpenAPI specs: ${result}`)
11  })
12  .catch(err => {
13    console.log(err)
14  })

Documentation

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

Differences from postman-to-openapi

There are some small differences between this library and the postman-to-openapi upstream:

• Does not ship with a CLI component.
• Has protections in place to prevent undefined statuses from being set.
• Has no version property on the exported method to determine which version you're running as this is unnecessary without a CLI component.