thedevsaddam / Docgen
Licence: mit
Transform your postman collection to HTML/Markdown documentation
Stars: ✭ 498
Programming Languages
go
31211 projects - #10 most used programming language
Projects that are alternatives of or similar to Docgen
Custom-Software-For-Xiaomi-Dafang
API and panel site for Xiaomi Dafang
Stars: ✭ 36 (-92.77%)
Mutual labels: api-documentation, api-client
Api Development Tools
📚 A collection of useful resources for building RESTful HTTP+JSON APIs.
Stars: ✭ 2,519 (+405.82%)
Mutual labels: api-client, api-documentation
webapi
WAI based library for web api
Stars: ✭ 27 (-94.58%)
Mutual labels: api-documentation, api-client
docodile
Generate HTML API documentation from a Postman collection
Stars: ✭ 63 (-87.35%)
Mutual labels: api-documentation, postman-collection
eoLinker
在线 API 研发管理测试工具，最后能用的开源修复版本（4.0.1本地测试插件兼容3.5与4.0版本）。
Stars: ✭ 62 (-87.55%)
Mutual labels: api-documentation, api-client
Octokit.swift
A Swift API Client for GitHub and GitHub Enterprise
Stars: ✭ 325 (-34.74%)
Mutual labels: api-client
Php Redmine Api
A simple PHP Redmine API client, Object Oriented
Stars: ✭ 392 (-21.29%)
Mutual labels: api-client
Malsub
A Python RESTful API framework for online malware analysis and threat intelligence services.
Stars: ✭ 308 (-38.15%)
Mutual labels: api-client
Insomnia
The open-source, cross-platform API client for GraphQL, REST, and gRPC.
Stars: ✭ 18,969 (+3709.04%)
Mutual labels: api-client
Datafire
A framework for building integrations and APIs
Stars: ✭ 487 (-2.21%)
Mutual labels: api-client
Python Redmine
Python Redmine is a library for communicating with a Redmine project management application
Stars: ✭ 440 (-11.65%)
Mutual labels: api-client
Ghlocalapi
(Unofficial) Google Home local API documentation.
Stars: ✭ 334 (-32.93%)
Mutual labels: api-documentation
Pywikibot
🤖 A Python library that interfaces with the MediaWiki API. This is a mirror from gerrit.wikimedia.org. Do not submit any patches here. See https://www.mediawiki.org/wiki/Developer_account for contributing.
Stars: ✭ 399 (-19.88%)
Mutual labels: api-client
Node Imdb Api
A non-scraping, functional node.js interface to imdb (mirror of gitlab.com/worr/node-imdb-api)
Stars: ✭ 314 (-36.95%)
Mutual labels: api-client
Vsphere Automation Sdk Python
Python samples, language bindings, and API reference documentation for vSphere, VMC, and NSX-T using the VMware REST API
Stars: ✭ 451 (-9.44%)
Mutual labels: api-client
Aiodocker
Python Docker API client based on asyncio and aiohttp
Stars: ✭ 288 (-42.17%)
Mutual labels: api-client
Wptools
Wikipedia tools (for Humans): easily extract data from Wikipedia, Wikidata, and other MediaWikis
Stars: ✭ 371 (-25.5%)
Mutual labels: api-client
Openapi To Postman
Plugin for converting OpenAPI 3.0 specs to the Postman Collection (v2) format
Stars: ✭ 365 (-26.71%)
Mutual labels: postman-collection
Docgen
Transform your postman collection to HTML/Markdown documentation
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 \
&& 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
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 8000This 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 -mThis 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
Contributor
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.
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].