https://github.com/mamund/alps-unified
Utility for converting ALPS API description documents into API Definition documents (OpenAPI, Proto, etc.)
https://github.com/mamund/alps-unified
Last synced: 2 months ago
JSON representation
Utility for converting ALPS API description documents into API Definition documents (OpenAPI, Proto, etc.)
- Host: GitHub
- URL: https://github.com/mamund/alps-unified
- Owner: mamund
- Created: 2020-11-21T18:48:22.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-15T02:21:51.000Z (4 months ago)
- Last Synced: 2024-10-22T10:51:11.591Z (4 months ago)
- Language: JavaScript
- Size: 1.29 MB
- Stars: 39
- Watchers: 4
- Forks: 4
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - mamund/alps-unified - Utility for converting ALPS API description documents into API Definition documents (OpenAPI, Proto, etc.) (JavaScript)
README
# ALPS Unified
Utility for converting ALPS API description documents (in YAML or JSON format) into target API definition documents (OpenAPI, SDL, Proto3, AsyncAPI, WSDL). Also converts alps YAML into alps JSON.
**NOTE**
> This utility is based on a presentation (and initial demo) here: https://github.com/mamund/2020-04-unified-api-design
### USAGE
```
-ws:~$unified -h
Usage: -f -t -o
Options:
--help Show help [boolean]
--version Show version number [boolean]
-f, --file Input file (alps.[yaml|JSON]) [string] [required]
-t, --type Format Type
([j]son, [p]roto, [s]dl, [a]syncapi, [o]penapi, [w]sdl) [string]
-o, --out Output file [string]
```
### INSTALL
* Requires NodeJS
```
npm install -g
```