docgen

Transform your postman collection to HTML/Markdown documentation

Github stars Tracking Chart

Docgen

Transform your postman collection to HTML/Markdown documentation

Task screenshot

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

Windows

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

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

Demo markdown API 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 :beers:!

Beerpay Beerpay

Main metrics

Overview
Name With Ownerthedevsaddam/docgen
Primary LanguageGo
Program languageShell (Language Count: 4)
Platform
License:MIT License
所有者活动
Created At2018-01-04 15:08:08
Pushed At2023-06-18 05:08:50
Last Commit At2019-01-23 15:29:43
Release Count11
Last Release Namev3.3.0 (Posted on 2022-01-26 00:02:28)
First Release Namev1.0 (Posted on 2018-01-04 21:17:41)
用户参与
Stargazers Count1k
Watchers Count15
Fork Count136
Commits Count115
Has Issues Enabled
Issues Count51
Issue Open Count24
Pull Requests Count20
Pull Requests Open Count3
Pull Requests Close Count6
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private