Read the Docs | Edit the Docs | View Demo

Core Features

• 📃 Document domains, services and messages from your GraphQL schema files (example)
• 📊 Visualise your architecture (demo)
• ⭐ Download your GraphQL schema files from EventCatalog (demo)
• 💅 Custom MDX components (read more)
• 🗄️ Auto versioning of your domains, services and messages
• ⭐ Document queries, mutations, and subscriptions from your GraphQL schema
• ⭐ 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 GraphQL plugin you can connect your GraphQL schema files to your catalog. This is done by defining your generators in your eventcatlaog.config.js file.

...
generators: [
    [
      '@eventcatalog/generator-graphql',
      {
        services: [
          {
            id: 'User Service',
            version: '1.0.0',
            name: 'User Service',
            // Path to your GraphQL schema file
            path: path.join(__dirname, 'graphql-schemas', 'user-service.graphql'),
          },
          {
            id: 'Order Service',
            version: '1.0.0',
            name: 'Order Service',
            // Path to your GraphQL schema file
            path: path.join(__dirname, 'graphql-schemas', 'order-service.graphql'),
          },
        ],
        // Maps the user service to the orders domain to the E-Commerce domain
        domain: { id: 'e-commerce', name: 'E-Commerce', version: '0.0.1' },
      },
    ],
  ],
...

In this example the generator will read the user-service.graphql and order-service.graphql files and populate services and messages inside your catalog. It will add the services to the domain E-Commerce.

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

Getting started

Installation and configuration

Make sure you are on the latest version of EventCatalog.

1. Install the package

@eventcatalog/generator-graphql

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

3. Run the generate command

npm run generate

4. 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/basic-graphql/index.ts
4. Run tests pnpm run test

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 [email protected]