Skip to content
Transform your postman collection to HTML/Markdown documentation
Go Shell
Branch: v2
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
.gitattributes
.gitignore Add VFS generated assets to the repository Aug 28, 2019
CONTRIBUTING.md
LICENSE.md
README.md
assetfs_vfsdata.go
build-html.go
build-markdown.go
build.go
build.sh
collection.go
example-doc.md
example.json
funcmap.go
generate-asset.go
go.mod
go.sum
main.go
run
screenshot.png
server.go
version.go

README.md

Docgen

Transform your postman collection to html documentation

Task screenshot

Installation

go get -u github.com/thedevsaddam/docgen

Mac

brew tap thedevsaddam/cli https://github.com/thedevsaddam/homebrew-cli.git
brew install docgen

# update
brew upgrade docgen

Windows

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

Binary link

Download binary

Available features

  • Live postman collection to documentation
  • Build postman collection to html/markdown documentation
  • Supports multi-level collection build

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

See example API markdown documentation

Author

  1. Sajib Sikder
  2. Saddam H

Contributor

  1. Anondo

Contribution

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

See all contributors

License

The docgen is an open-source software licensed under the MIT License.

Support on Beerpay

Hey dude! Help me out for a couple of 🍻!

Beerpay Beerpay

You can’t perform that action at this time.