Docs generator for Postman
Docs generator for Postman REST Client. Docman parses Postman dump files and outputs documentation as set of Markdown files.
Install Docman globally:
npm install -g docman
Docman takes two arguments:
dump: file path to Postman JSON dump file (in Postman Settings -> Data -> Export data)
dir: output directory where Docman should generate docs. If provided directory is not writable, Docman will try to generate docs to
docman <dump> <dir>
docman ./Backup.postman_dump /Users/me/myapp/api_docs
Docman bundles Dockerfile for building working development environment. Assuming you have installed Docker, from Docman clonned directory type:
# build image (only once for each Dockerfile) docker build -t <namespace>/docman.dev:0.1 . # run container (anytime to start dev) docker run -it --rm -v `pwd`:/src <namespace>/docman.dev:0.1
This will build and run development container, that will delete itself after exiting. Sources are mounted to
/src. To install current code as global module (for testing puporse) use:
npm install -g .
docman will run latest code version.
Copyright (c) 2015, Ilya Rusanen. (MIT License)
See LICENSE for more info.