Skip to content
Transform your postman collection to HTML/Markdown documentation
Go Shell
Branch: v2
Clone or download
thedevsaddam Merge pull request #20 from Enrico204/add-sort-switch
Add `-s` switch to enable collection sorting
Latest commit 0c6067e Aug 7, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets Merge pull request #19 from Enrico204/fix-raw-request-body-in-html Aug 7, 2019
.gitattributes Initial commit Jan 4, 2018
.gitignore Implement vfsgen and generate static assets during the build (with go… Aug 6, 2019
CONTRIBUTING.md Initial commit Jan 4, 2018
LICENSE.md
README.md Add Beerpay's badge Jul 6, 2019
build-html.go Add markdown format Jan 25, 2019
build-markdown.go Update build-markdown.go Apr 7, 2019
build.go
build.sh Fix bash scripts to generate static assets before build Aug 6, 2019
collection.go Merge pull request #20 from Enrico204/add-sort-switch Aug 7, 2019
example-doc.md Add logo and info url Feb 12, 2019
example.json
funcmap.go Implement vfsgen and generate static assets during the build (with go… Aug 6, 2019
generate-asset.go Implement vfsgen and generate static assets during the build (with go… Aug 6, 2019
go.mod Implement vfsgen and generate static assets during the build (with go… Aug 6, 2019
go.sum Implement vfsgen and generate static assets during the build (with go… Aug 6, 2019
main.go Merge pull request #20 from Enrico204/add-sort-switch Aug 7, 2019
run Fix bash scripts to generate static assets before build Aug 6, 2019
screenshot.png Merge branch 'v2' of https://github.com/thedevsaddam/docgen into v2 Feb 5, 2019
server.go Add `-s` switch to enable collection sorting Aug 7, 2019
version.go Update version no Apr 12, 2019

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.