• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

thedevsaddam/docgen: Transform your postman collection to HTML/Markdown document ...

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称(OpenSource Name):

thedevsaddam/docgen

开源软件地址(OpenSource Url):

https://github.com/thedevsaddam/docgen

开源编程语言(OpenSource Language):

Go 87.2%

开源软件介绍(OpenSource Introduction):

Docgen

Transform your postman collection to HTML/Markdown documentation

Task screenshot

Installation/Update on Mac/Linux

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

Uninstallation

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

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

Demo markdown API documentation

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.




鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap