Transform your postman collection to html documentation
go get -u github.com/thedevsaddam/docgen
brew tap thedevsaddam/cli https://github.com/thedevsaddam/homebrew-cli.git
brew install docgen
# update
brew upgrade docgen
For windows download the binary and set environment variable so that you can access the binary from terminal
- Live postman collection to documentation
- Build postman collection to html/markdown documentation
- Supports multi-level collection build
- To view live HTML documentation from postman collection use
docgen server -f input-postman-collection.json -p 8000
This will open the html version of postman collection to the defined port - To view live Markown documentation from postman collection use
docgen server -f input-postman-collection.json -p 8000 -m
This will open the markdown version of postman collection to the defined port - To make HTML documentation use
docgen build -i input-postman-collection.json -o ~/Downloads/index.html
- To make Markdown documentation use
docgen build -i input-postman-collection.json -o ~/Downloads/index.md -m
See example API markdown documentation
Your suggestions will be more than appreciated. Read the contribution guide here
See all contributors
The docgen is an open-source software licensed under the MIT License.
Hey dude! Help me out for a couple of 🍻!