https://github.com/markruler/swage-js
Swage in Node.js
https://github.com/markruler/swage-js
Last synced: about 2 months ago
JSON representation
Swage in Node.js
- Host: GitHub
- URL: https://github.com/markruler/swage-js
- Owner: markruler
- License: mit
- Created: 2020-12-15T01:49:28.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-03-21T08:39:58.000Z (about 4 years ago)
- Last Synced: 2025-03-24T11:49:34.726Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/swage
- Size: 6.82 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Swage
> Deprecated: move to [cxsu/swage](https://github.com/cxsu/swage)
> CLI tool for converting Swagger API specification JSON to Excel
## Getting started
### Install
```bash
npm install --global swage
```
```bash
yarn global add swage
```
### Command
```bash
swage gen --help
# generate an excel file in the current directory
swage gen
```
## Example
- [swagger.json](https://editor.swagger.io/)
```bash
swage gen example/example.json
OUTPUT >>> ./swagger.xlsx
```
### flag `--output`, `-o`
```bash
swage gen example/example.json --output example
OUTPUT >>> ./example/swagger.xlsx
```
## Development
### Build
```bash
npm install
npm run build
```
### Run
```bash
node dist/main.js gen example/example.json --output .
```
### Local Install
```bash
npm run local
# /usr/local/bin/swage -> /usr/local/lib/node_modules/swage/dist/main.js
# + [email protected]
# added 1 package from 1 contributor in 0.667s
```
### Clean
```bash
npm run clean
```
## Reference
- [swagger-codegen](https://github.com/swagger-api/swagger-codegen)
- [JSDoc 3](https://jsdoc.app)
- [Jest](https://jestjs.io)
- [realworld.json](https://github.com/xesina/golang-echo-realworld-example-app)