https://github.com/event-catalog/generators
Plugin integrations for EventCatalog
https://github.com/event-catalog/generators
asyncapi event-driven-architecture eventbridge openapi
Last synced: 2 months ago
JSON representation
Plugin integrations for EventCatalog
- Host: GitHub
- URL: https://github.com/event-catalog/generators
- Owner: event-catalog
- License: other
- Created: 2025-02-05T09:47:21.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-02-14T14:55:05.000Z (2 months ago)
- Last Synced: 2025-02-14T15:40:32.646Z (2 months ago)
- Topics: asyncapi, event-driven-architecture, eventbridge, openapi
- Language: TypeScript
- Homepage: https://eventcatalog.dev
- Size: 6.08 MB
- Stars: 4
- Watchers: 0
- Forks: 1
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Funding: .github/funding.yml
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# EventCatalog Generators
This repository contains the generators for the EventCatalog project.
## Integration list with EventCatalog
- [OpenAPI](./packages/generator-openapi/README.md)
- [Documentation](https://www.eventcatalog.dev/integrations/openapi)
- [Example Projects](./examples/generator-openapi/)
- [AsyncAPI](./packages/generator-asyncapi/README.md)
- [Documentation](https://www.eventcatalog.dev/integrations/asyncapi)
- [Example Projects](./examples/generator-asyncapi/)
- [EventCatalog Federation](./packages/generator-federation/README.md)
- [Documentation](https://www.eventcatalog.dev/federation)
- [Amazon EventBridge](./packages/generator-eventbridge/README.md)
- [Documentation](https://www.eventcatalog.dev/integrations/eventbridge)
- [Backstage](https://github.com/event-catalog/backstage-plugin-eventcatalog)
- [Documentation](https://www.eventcatalog.dev/integrations/backstage)
All plugins require a license key. You can get a license key from [EventCatalog Cloud](https://eventcatalog.cloud).
---
## Examples
**OpenAPI Integrations [(watch demo)](https://www.youtube.com/watch?v=E6cXxQXH49k)**
- [Integrate OpenAPI files into EventCatalog](./examples/generator-openapi/)
- [Integrate OpenAPI files from remote URLs into EventCatalog](./examples/generator-openapi/fetch-from-remote-urls/)
- [Mapping commands, events and queries using the `x-eventcatalog-message-type` extension](./examples/generator-openapi/mapping-commands-events-queries/)
- [Independent Message Versioning using the `x-eventcatalog-message-version` extension](./examples/generator-openapi/independent-message-versioning/)
**AsyncAPI Integrations [(watch demo)](https://www.youtube.com/watch?v=XglwSNAnpKY)**
- [Integrate AsyncAPI files into EventCatalog](./examples/generator-asyncapi/)
- [Integrate AsyncAPI files from remote URLs into EventCatalog](./examples/generator-asyncapi/fetch-from-remote-urls/)
- [Mapping commands, events and queries using the `x-eventcatalog-message-type` extension](./examples/generator-asyncapi/mapping-commands-events-queries/)
- [Independent Message Versioning using the `x-eventcatalog-message-version` extension](./examples/generator-asyncapi/independent-message-versioning/)
- [Message Ownership using the `x-eventcatalog-role` extension to control which service owns a message](./examples/generator-asyncapi/message-ownership/)
- EventCatalog will parse all messages, sometimes this leads to duplicated messages being created.
- The `x-eventcatalog-role` extension can be used to control which service owns a message.
- This is useful when you have multiple AsyncAPI files that define the same message.
**EventBridge Integrations [(watch demo)](https://www.youtube.com/watch?v=MeBuwAflwM4)**
- [Import EventBridge schemas into EventCatalog using schema discovery](./examples/generator-eventbridge/basic/)
- [Import EventBridge schemas into EventCatalog using a custom schema registry](./examples/generator-eventbridge/custom-registry/)
**EventCatalog Federation [(watch demo)](https://www.youtube.com/watch?v=KnTQkrt-7cc)**
- [Merge multiple catalogs into one central catalog](./examples/generator-federation/basic/)
- Give your teams their own EventCatalog instance, and use the federation plugin to merge them together.
- Let your teams focus on what they do best, and use the federation plugin to merge their documentation together.
- The central catalog is hosted for the organization where people can view the merged catalog and single source of truth.
**Backstage Integrations [(watch demo)](https://www.youtube.com/watch?v=mjf7qwoSAC4)**
- [Integrate Backstage plugin into EventCatalog](https://github.com/event-catalog/backstage-eventcatalog-demo)
**Multi Generator Example**
- [Integrate multiple generators (AsyncAPI and OpenAPI) into EventCatalog](./examples/multi-generator-example/)
---
## Found a problem?
Raise a GitHub issue on this project, or contact us on [our Discord server](https://discord.gg/3rjaZMmrAm).
## Commercial use
All plugins are licensed under a [dual-license](./LICENSE.md). 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](./LICENSE-COMMERCIAL.md).
If you would like to obtain a Commercial License, you can get a free trial (14 days) per plugin at https://eventcatalog.cloud or email us at `[email protected]`
# Sponsors
Thank you to our project sponsors.
## Gold sponsors
_Sponsors help make EventCatalog sustainable, want to help the project? Get in touch! Or [visit our sponsor page](https://github.com/sponsors/event-catalog)._
# Enterprise support
Interested in collaborating with us? Our offerings include dedicated support, priority assistance, feature development, custom integrations, and more.
Find more details on our [services page](https://eventcatalog.dev/services).
# Contributing
If you have any questions, features or issues please raise any issue or pull requests you like. We will try my best to get back to you.
You can find the [contributing guidelines here](https://eventcatalog.dev/docs/contributing/overview).
