Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/joaomlneto/asyncapi-spring-websockets-template

AsyncAPI Generator Template for Spring Websockets
https://github.com/joaomlneto/asyncapi-spring-websockets-template

asyncapi generator spring template websockets

Last synced: 23 days ago
JSON representation

AsyncAPI Generator Template for Spring Websockets

Awesome Lists containing this project

README

        

# AsyncAPI Spring WebSockets Generator

## Usage

### From the command-line interface (CLI)
```shell
Usage: ag [options] @joaomlneto/asyncapi-spring-websockets-template

Options:
-V, --version output the version number
-o, --output directory where to put the generated files (defaults to current directory)
-p, --param additional param to pass to templates
-h, --help output usage information
```

### Supported parameters

### Examples

Shortest possible syntax:

```shell
ag asyncapi.yaml @joaomlneto/asyncapi-spring-websockets-template
```

## Development

1. Clone the repository
```shell
git clone https://github.com/joaomlneto/asyncapi-spring-websockets-template
cd asyncapi-spring-websockets-template
```

2. Make sure the template has all the dependencies installed
```shell
yarn
```

3. Install the AsyncAPI Generator
```shell
npm install -g @asyncapi/generator
```

4. Run generation
```shell
// TODO
```

## Run it

// TODO

## Missing features

// TODO

## Contributors

// TODO