nickspacek / generator

Use your AsyncAPI definition to generate literally anything. Markdown documentation, Node.js code, HTML documentation, anything!

AsyncAPI Generator

Use your AsyncAPI definition to generate literally anything. Markdown documentation, Node.js code, HTML documentation, anything!

⚠️ This package doesn't support AsyncAPI 1.x anymore. We recommend to upgrade to the latest AsyncAPI version using the AsyncAPI converter. If you need to convert documents on the fly, you may use the Node.js or Go converters.

Install

npm install -g asyncapi-generator

Or use all the commands below using Docker by replacing ag in all the commands below with:

docker run --rm -it -v $PWD:/app -w /app asyncapi/generator [COMMAND HERE]

Usage

From the command-line interface (CLI)

  Usage: ag [options] <asyncapi> <template>


  Options:

    -V, --version                  output the version number
    -w, --watch                    watches the the template directory and the async api document for change, and re-generate the files when they occour.
    -o, --output <outputDir>       directory where to put the generated files (defaults to current directory) (default: /Users/fmvilas/www/asyncapi-generator)
    -d, --disable-hook <hookName>  disable a specific hook
    -n, --no-overwrite <glob>      glob or path of the file(s) to skip when regenerating
    -p, --param <name=value>       additional param to pass to templates
    -t, --templates <templateDir>  directory where templates are located (default: Internal template folder)
    -h, --help                     output usage information

Examples

The shortest possible syntax:

ag asyncapi.yaml markdown

Specify where to put the result:

ag -o ./docs asyncapi.yaml markdown

Passing parameters to templates:

ag -o ./docs --param title='Hello from param' asyncapi.yaml markdown

In the template you can use it like this: {{ params.title }}

File templating

To separate functionality into files, one can specify a filename like $$channel$$.js to generate a file for each channel defined in your specification. The following separations are supported: $$channel$$, $$message$$, $$schema$$, $$parameter$$ and $$securityScheme$$.

As of right now $$message$$, $$schema$$, $$parameter$$ and $$securityScheme$$ are only supported if it is defined in the component section (#170).

As a module

See API documentation.

Authoring templates

See Authoring templates.

Requirements

• Node.js v8.5+

Contributing

Contributions are more than welcome. If you want to make a contribution, please make sure you go through the following steps:

1. Pick or create an issue. It's always a good idea to leave a message saying that you're going to work on it before you start any actual work.
2. Fork the repository and work there.
3. Open a Pull Request pointing to master branch.
4. A maintainer will review and, eventually, merge your Pull Request. Please, be patient as most of us are doing this in our spare time.

Author

Fran Méndez (@fmvilas)