Docgen
Transform your postman collection to html documentation
Installation
go get -u github.com/thedevsaddam/docgen
Mac
brew tap thedevsaddam/cli https://github.com/thedevsaddam/homebrew-cli.git
brew install docgen
Linux/Windows
Available features
- Live postman collection to documentation
- Build postman collection to html/markdown documentation
- Supports multi-level collection build
Usage
- To see live 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 build a HTML documentation use
docgen build -i input-postman-collection.josn -o ~/Downloads/index.html
- To build a Markdown documentation use
docgen build -i input-postman-collection.josn -o ~/Downloads/index.md -m
See example API markdown documentation
Author
Contributor
Contribution
Your suggestions will be more than appreciated. Read the contribution guide here
contributors
See allLicense
The docgen is an open-source software licensed under the MIT License.