postman-to-openapi-json-extended

1.0.2 • Public • Published

postman-to-openapi-json-extended

Convert Postman collection to OpenAPI Specs with extended components

Heavily inspired by and extending: postman-to-openapi

Installation

npm install -g postman-to-openapi-json-extended

Usage

help

extract

build

Extract

Extract request-response schemas paths from a exported postman collection. These schema paths are automatically populated by building a JSON schema from the examples provided (if any)

Steps:

  • Run: p2ojx extract to extact from the .postman_collection.json file present in the working directory.

    To explicitly pass a postman collection file, use the file path as the argument

  • This will create a schemas directory and all the extracted paths will be written in the schemas/_extracted.json file

The _extracted.json file is used for staging purposes. It is advised to rename this file before building the docs. Running the extrct command next time might over-write this file!

  • Segregate the paths into multiple files for easier maintainance. Make sure all the files are in .json format and lie in the root of the schemas directory
  • References can be used in the JSON schema files. While using references, make sure to treat the parent directory of the schemas file as root. Example:
{
  "paths./health.get.responses.200.content.application/json.schema": {
    "$ref": "schemas/components/Health.json"
  }
}

Build

Build the openapi.json file with all the data coming on from the postman collection file along with the extended schema

Steps

  • Create a configuration file. Name it: config.p2ojx.json. For more info about configurations, read here
  • Run: p2ojx build to extact from the .postman_collection.json and config.p2ojx.json file present in the working directory.
    • To explicitly pass a postman collection file, use -p to sepecify the path
    • To pass a configuration file, use -c option
  • This will create an openapi.json file in the present working directory

Extensibility

Other components/schemas can be added in alongside the extracted request/response schemas. Each one should be point in the correct path and should be withon .json files in the schemas directory. Check out the schemasa/_extracted.json to understand correct format

Limitations

  • Doesn't track changes on the Postman collections
  • APIs deleted in the Postman collections aren't reflected in the already extracted schemas (Requires manual delete)
  • API paths modified in the Postman collections, aren't picked up seperately. Thy're treated as new paths

Readme

Keywords

none

Package Sidebar

Install

npm i postman-to-openapi-json-extended

Weekly Downloads

0

Version

1.0.2

License

MIT

Unpacked Size

664 kB

Total Files

10

Last publish

Collaborators

  • kinjalrk2k