alioygur/postman2html

postman collection to html

v1.3 2014-12-09 12:51 UTC

Requires

• michelf/php-markdown: ~1.4
• symfony/console: ~2.6

Requires (Dev)

• phpunit/phpunit: ~4.6@dev

MIT

• Ali OYGUR

README

Generating html file from a postman collection file. it is useful for API documentation.

Installation

This library is available via Composer

composer global require "alioygur/postman2html=~1.0"

Usage

Simple example of usage

postman2html render location-of-postman-collection-file.json

Custom output file location and name, instead of default

postman2html render location-of-postman-collection-file.json path/to/apidoc.html

Help

postman2html help render

Output of postman2html help render command

Usage:
 render inputfile [outputfile]

Arguments:
 inputfile             input file
 outputfile            output file (default: "output.html")

Options:
 --help (-h)           Display this help message.
 --quiet (-q)          Do not output any message.
 --verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.
 --version (-V)        Display this application version.
 --ansi                Force ANSI output.
 --no-ansi             Disable ANSI output.
 --no-interaction (-n) Do not ask any interactive question.