docgen-bin
docgen-bin copied to clipboard
Transform your postman collection to html documentation
Docgen binary
Transform your postman collection to html documentation
Download
OS | x86 | x86_64 |
---|---|---|
Mac | Download | Download |
Linux | Download | Download |
Windows | Download | Download |
Installation on Mac/Linux
curl https://raw.githubusercontent.com/thedevsaddam/docgen/v3/install.sh -o install.sh && sudo chmod +x install.sh && sudo ./install.sh
For windows download the binary and set environment variable so that you can access the binary from terminal
Download Latest Binary
Available features
- Live postman collection to documentation
- Build postman collection to HTML/Markdown documentation
- Supports multi-level collections
Usage
- 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