# Installation

Copy as Markdown[View as Markdown](/docs/plugins/openapi/installation.md)

***

**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[​](#installation "Direct link to Installation")

Run the command below to install the EventCatalog OpenAPI plugin.

* Install on existing catalog
* Create new catalog with OpenAPI plugin

```
npm i @eventcatalog/generator-openapi
```

```
npx @eventcatalog/create-eventcatalog@latest my-catalog --template openapi
```

#### Configuration[​](#configuration "Direct link to 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[​](#configure-license-key "Direct link to Configure license key")

The EventCatalog OpenAPI plugin requires a license key to work with EventCatalog.

You can get a trial license key from [EventCatalog Cloud](https://eventcatalog.cloud).

You have a few options for setting the license key:

1. [Setting license key in `.env` file (recommended)](#setting-license-key-in-env-file-recommended)
2. [Setting license key in eventcatalog.config.js](#setting-license-key-in-eventcatalogconfigjs)

#### 1. Setting license key in `.env` file (recommended)[​](#1-setting-license-key-in-env-file-recommended "Direct link to 1-setting-license-key-in-env-file-recommended")

**Added in** `eventcatalog@2.35.4`

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

.env

```
EVENTCATALOG_LICENSE_KEY_OPENAPI=your-license-key
```

Using an older version of EventCatalog?

If you are using an older version of EventCatalog that does not support the `.env` file, you can just export the license key as an environment variable.

Setting license key in environment variables

```
export EVENTCATALOG_LICENSE_KEY_OPENAPI=your-license-key
```

### White listing domains[​](#white-listing-domains "Direct link to 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[​](#2-setting-license-key-in-eventcatalogconfigjs "Direct link to 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_LICENSE_KEY_OPENAPI
      },
    ],
  ],
};
```

#### Run the plugin[​](#run-the-plugin "Direct link to Run the plugin")

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

```
npm run generate
```

#### View your catalog[​](#view-your-catalog "Direct link to View your catalog")

Run your catalog locally to see the changes

```
npm run dev
```

## Any questions or need help?[​](#any-questions-or-need-help "Direct link to Any questions or need help?")

If you get stuck, find an issue or need help, please raise an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues) or join our [Discord community](https://eventcatalog.dev/discord).