Skip to main content

Installation

View as Markdown
License: Dual-license

The OpenAPI plugin is used to generate a catalog from an OpenAPI specification files.

You can map your OpenAPI files to commands, events and queries in your catalog, and assign these to services and domains.

Installation​

Run the command below to install the EventCatalog OpenAPI plugin.

npm i @eventcatalog/generator-openapi

Configuration​

Configure the plugin in your eventcatalog.config.js file.

Add the plugin to the generators array.

eventcatalog.config.js
// ...
generators: [
  [
    '@eventcatalog/generator-openapi',
    {
      services: [
        { path: path.join(__dirname, 'openapi-files', 'orders-service.yml'), id: 'orders-service' },
      ],
      domain: { id: 'orders', name: 'Orders', version: '0.0.1' },
    },
  ],
  // Add many openapi files to a domain
  [
    '@eventcatalog/generator-openapi',
    {
      services: [
        { path: path.join(__dirname, 'openapi-files', 'payment-service.yml'), id: 'payment-store' },
        { path: path.join(__dirname, 'openapi-files', 'fraud-detection-service.yml'), id: 'fraud-detection-service' },
      ],
      domain: { id: 'payment', name: 'Payment', version: '0.0.1' },
    },
  ],
],
};

Configure license key​

The EventCatalog OpenAPI plugin requires an EventCatalog Scale license key to work with EventCatalog.

You can get a trial Scale license key from EventCatalog Cloud.

You have a few options for setting the license key:

  1. Setting license key in .env file (recommended)
  2. Setting license key in eventcatalog.config.js
Added in eventcatalog@2.35.4

Create a .env file in the root of your project and add the following:

.env
EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
Using an Older API Key?

If you already have an older OpenAPI plugin key, you can still use it with the OpenAPI-specific environment variable.

.env
EVENTCATALOG_LICENSE_KEY_OPENAPI=your-license-key

White listing domains​

If you are behind a firewall you will need to white list the domain https://api.eventcatalog.cloud in your firewall. This is because the plugin needs to verify your license key.

2. Setting license key in eventcatalog.config.js​

If you prefer, you can set the license key in the eventcatalog.config.js file using the licenseKey property in the EventCatalog OpenAPI plugin.

eventcatalog.config.js
export default {
  generators: [
    [
      '@eventcatalog/generator-openapi',
      {
        licenseKey: '[INSERT_YOUR_LICENSE_KEY]', // or process.env.EVENTCATALOG_SCALE_LICENSE_KEY
      },
    ],
  ],
};

Run the plugin​

This command will run the generators in your eventcatalog.config.js file.

npm run generate

View your catalog​

Run your catalog locally to see the changes

npm run dev

Any questions or need help?​

If you get stuck, find an issue or need help, please raise an issue on GitHub or join our Discord community.