Configuration file

You can configure your AsyncAPI Generator template using either a dedicated .ageneratorrc YAML file or through the generator property in your package.json file. Previously, generator configuration had to be defined in the package.json file. Now, you can define the configuration in a separate .ageneratorrc file. The configuration defined in the .ageneratorrc file will override any configuration defined in package.json. The generator will first check for the .ageneratorrc file in the template's root directory, and if not found, it will look for the generator config in package.json.

Configuration Methods

Option 1: Using .ageneratorrc file (Recommended)

Create a .ageneratorrc file in the root of your template with YAML syntax. This approach keeps your template configuration separate from package metadata:

1renderer: react
2apiVersion: v3
3supportedProtocols:
4  - amqp
5  - mqtt
6parameters:
7  server:
8    description: The server you want to use in the code.
9    required: true
10  dummyParameter:
11    description: Example of parameter with default value.
12    default: just a string
13    required: false
14conditionalFiles:
15  path/to/file/that/is/relative/to/template/dir/test-amqp.js:
16    subject: server.protocol
17    validation:
18      const: amqp
19  path/to/file/that/is/relative/to/template/dir/support.html:
20    subject: info.contact
21    validation:
22      required:
23        - url
24nonRenderableFiles:
25  - src/api/middlewares/*.*
26  - lib/lib/config.js
27generator: <"2.0.0"
28filters:
29  - my-package-with-filters
30hooks:
31  '@asyncapi/generator-hooks': hookFunctionName
32  my-custom-hooks-package:
33    - myHook
34    - andAnotherOne

Option 2: Using package.json

Alternatively, you can include your configuration in the generator property of your package.json file:

1"generator": {
2  "renderer": "react",
3  "apiVersion": "v3",
4  "supportedProtocols": ["amqp", "mqtt"],
5  "parameters": {
6    "server": {
7      "description": "The server you want to use in the code.",
8      "required": true
9    },
10    "dummyParameter": {
11      "description": "Example of parameter with default value.",
12      "default": "just a string",
13      "required": false
14    }
15  },
16  "conditionalFiles": {
17    "path/to/file/that/is/relative/to/template/dir/test-amqp.js": {
18      "subject": "server.protocol",
19      "validation": {
20        "const": "amqp"
21      }
22    },
23    "path/to/file/that/is/relative/to/template/dir/support.html": {
24      "subject": "info.contact",
25      "validation": {
26        "required": ["url"]
27      }
28    }
29  },
30  "nonRenderableFiles": [
31    "src/api/middlewares/*.*",
32    "lib/lib/config.js"
33  ],
34  "generator": "<2.0.0",
35  "filters": [
36    "my-package-with-filters"
37  ],
38  "hooks": {
39    "@asyncapi/generator-hooks": "hookFunctionName",
40    "my-custom-hooks-package": ["myHook", "andAnotherOne"]
41  }
42}

Note: If both .ageneratorrc file and the generator property in package.json exist, the configuration from .ageneratorrc will override the package.json configuration.

The generator property from package.json file and must contain a JSON object and the ageneratorrc file must contain a YAML object that may have the following information:

Special parameters

There are some template parameters that have a special meaning: