Skip to content

README.md

Latest commit

 

History

History
109 lines (75 loc) · 4.89 KB

README.md

File metadata and controls

109 lines (75 loc) · 4.89 KB

⚡️ OpenAPI generator for EventCatalog

PRs Welcome blog

header

Features: Generate EventCatalogs with your OpenAPI files, Auto versioning, schema downloads, map to domains, custom OpenAPI extensions and more...

Read the Docs | Edit the Docs | View Demo

Core Features

  • 📃 Document domains, services and messages from your OpenAPI files (example)
  • 📊 Visualise your architecture (demo)
  • ⭐ Download your OpenAPI files from EventCatalog (demo)
  • 💅 Custom MDX components (read more)
  • 🗄️ Auto versioning of your domains, services and messages
  • ⭐ Discoverability feature (search, filter and more) (demo)
  • ⭐ And much more...

How it works

EventCatalog is technology agnostic, meaning it can integrate with any schemas, specs or brokers.

EventCatalog supports generators. Generators are scripts are run to pre build to generate content in your catalog. Generators can use the EventCatalog SDK.

With this OpenAPI plugin you can connect your OpenAPI files to your catalog. This is done by defining your generators in your eventcatlaog.config.js file.

...
generators: [
    [
      '@eventcatalogtest/generator-openapi',
      {
        services: [
          { path: [path.join(__dirname, 'openapi-files', 'petstore.yml'), id: 'pet-store' },
          { path: [path.join(__dirname, 'openapi-files', 'account-service.yml'), id: 'account-service' },
        ],
        domain: { id: 'orders', name: 'Orders', version: '0.0.1' },
      },
    ],
  ],
...

In this example the generator will read the petstore.yml file and populate services and messages inside your catalog. It will add the service to the domain Orders.

You can see an example in the eventcatalog-openapi-example repo

Getting started

Installation and configuration

Make sure you are on the latest version of EventCatalog.

  1. Install the package
@eventcatalog/generator-openapi

  1. Configure your eventcatalog.config.js file (see example)

  2. Run the generate command

npm run generate
  1. See your new domains, services and messages, run
npm run dev

Found a problem?

Raise a GitHub issue on this project, or contact us on our Discord server.

Running the project locally

  1. Clone the repo
  2. Install required dependencies pnpm i
  3. Run the examples `npx tsx examples/streelights-mqtt/index.ts
  4. Run tests pnpm run tests

Commercial Use

This project is governed by a dual-license. To ensure the sustainability of the project, you can freely make use of this software if your projects are Open Source. Otherwise for internal systems you must obtain a commercial license.

If you would like to obtain a Commercial License, you can purchase a license at https://dashboard.eventcatalog.dev or email us at hello@eventcatalog.dev.