Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thedevsaddam/docgen
Transform your postman collection to HTML/Markdown documentation
https://github.com/thedevsaddam/docgen
api-client api-documentation api-documentation-tool postman-collection
Last synced: 4 days ago
JSON representation
Transform your postman collection to HTML/Markdown documentation
- Host: GitHub
- URL: https://github.com/thedevsaddam/docgen
- Owner: thedevsaddam
- License: mit
- Created: 2018-01-04T15:08:08.000Z (almost 7 years ago)
- Default Branch: v3
- Last Pushed: 2023-06-18T05:08:50.000Z (over 1 year ago)
- Last Synced: 2024-08-02T03:08:16.112Z (4 months ago)
- Topics: api-client, api-documentation, api-documentation-tool, postman-collection
- Language: Go
- Homepage:
- Size: 2.39 MB
- Stars: 962
- Watchers: 15
- Forks: 132
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- my-awesome - thedevsaddam/docgen - client,api-documentation,api-documentation-tool,postman-collection pushed_at:2023-06 star:1.0k fork:0.1k Transform your postman collection to HTML/Markdown documentation (Go)
README
Docgen
=====================
Transform your postman collection to HTML/Markdown documentation
#### Installation/Update on Mac/Linux
```bash
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
```bash
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](https://github.com/thedevsaddam/docgen/releases)
### 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](_examples/example-doc.md)***
### Contributor
1. [Anondo](https://github.com/Anondo)
### Contribution
Your suggestions will be more than appreciated.
[Read the contribution guide here](CONTRIBUTING.md)
### See all [contributors](https://github.com/thedevsaddam/docgen/graphs/contributors)
### **License**
The **docgen** is an open-source software licensed under the [MIT License](LICENSE.md).