Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Convert PostMan Collection Report to Swagger file.

Project description

Convert PostMan Collection Report to Swagger file.

See: https://github.com/postmanlabs/newman#json-reporter-options

Install

Just pip install it as usual:

~$ pip install swagman

Or pip install it in developement:

~/swagman$ pip install -e .

Usage

Please just follow the help:

~$ swagman -h
usage: swagman [-h] [-b BASEPATH] [-e ENVIRONMENT] [-f OUTPUT_FORMAT]
              [-g _GLOBALS] [-H HOST] [-o OUTPUT] [-s SCHEMES]
              [-t EXTRA_TAGS] [--template TEMPLATE_PATH]
              input

Convert PostMan Collections to Swagger file.

positional arguments:
  input                 Path to the collection to convert

optional arguments:
  -h, --help            show this help message and exit
  -b BASEPATH, --base-path BASEPATH
                        Base path to a collection, ex: /api, default: /
  -e ENVIRONMENT, --environment ENVIRONMENT
                        Path to a collection environment file, default: None
  -f OUTPUT_FORMAT, --output-format OUTPUT_FORMAT
                        Output format between json or yaml, default: yaml
  -g _GLOBALS, --globals _GLOBALS
                        Path to a collection globals file, default: None
  -H HOST, --host HOST  Host of the collection file, ex.: 127.0.0.1, default:
                        None
  -o OUTPUT, --output OUTPUT
                        Path to the swagger file to generate, default:
                        swagger.yml
  -s SCHEMES, --schemes SCHEMES
                        Supported schemes of the collection file, ex.:
                        "http,https", default: https
  -t EXTRA_TAGS, --extra-tags EXTRA_TAGS
                        Additional tags to be included, ex: "sso,oauth",
                        default: ""
  --template TEMPLATE_PATH
                        Path to a template to use for swagger result rendering
                        (required for html ouput).

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for swagman, version 0.6
Filename, size File type Python version Upload date Hashes
Filename, size swagman-0.6-py2.py3-none-any.whl (8.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size swagman-0.6.tar.gz (8.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page