https://github.com/jesusr/docrester
https://github.com/jesusr/docrester
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/jesusr/docrester
- Owner: jesusr
- License: mit
- Created: 2019-12-18T20:41:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-02-12T21:00:45.000Z (over 4 years ago)
- Last Synced: 2025-08-09T04:46:03.573Z (10 months ago)
- Language: JavaScript
- Size: 110 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docrester [](https://github.com/RichardLitt/standard-readme)
## Description
An utility to convert a Postman collection json (v2, v2.1) to Swagger JSON.
## ✅ Prerequisites
In order to work with this project, your local environment must have at least the following versions:
* NodeJS Version: 12.xx
* NPM Version: 6.12.0
## 📐 How to work with this project
```bash
$./docrester [options]
```
### More config
Option | | Description | Type
--- | --- | --- | ---
--version | --vv | Version of the document | boolean
--output | -o | Path for the output file | string (default: "swagger.json")
--domain | -d | Url for host domain | string
--base | -b | Base path | string
--env | -e | Environment variables file path | string
--contact | -c | Contact info | boolean
--help | -h | Show help | boolean
### Examples
Creates a swagger json based in the "./test_environment.json ./test.json" test.json file including the test_environment variables.
```bash
$docrester -o ./swagger.json -e
```
## ⛽️ Review and Update Dependences
For review and update all npm dependences of this project you need install in global npm package "npm-check" npm module.
```bash
# Install and Run
$npm i -g npm-check
$npm-check
```
## Happy Code
Created with JavaScript, lot of ❤️ and a few ☕️
## This README.md file has been written keeping in mind
* [GitHub Markdown](https://guides.github.com/features/mastering-markdown/)
* [Emoji Cheat Sheet](https://www.webfx.com/tools/emoji-cheat-sheet/)