Repository files navigation

Transform your postman collection to HTML/Markdown documentation

curl https://raw.githubusercontent.com/thedevsaddam/docgen/v3/install.sh -o install.sh \&& sudo chmod +x install.sh \&& sudo ./install.sh \&& rm install.sh

curl https://raw.githubusercontent.com/thedevsaddam/docgen/v3/uninstall.sh -o uninstall.sh \&& sudo chmod +x uninstall.sh \&& sudo ./uninstall.sh \&& rm uninstall.sh

For windows download the binary and set environment variable so that you can access the binary from terminal

Download binary

• 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 usedocgen 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 usedocgen 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 usedocgen build -i input-postman-collection.json -o ~/Downloads/index.html
• To make Markdown documentation usedocgen build -i input-postman-collection.json -o ~/Downloads/index.md -m

Demo markdown API documentation

1. Anondo

Your suggestions will be more than appreciated.Read the contribution guide here

Thedocgen is an open-source software licensed under theMIT License.