Core Features

- 📃 Document domains, services and messages from your APIs
- 📊 Visualise your architecture (demo)
- View your OpenAPI files in EventCatalog and download schemas
- 💅 Custom MDX components (read more)
- 🗄️ Auto versioning of your domains, services and messages
- ⭐ Map routes to commands, queries and events in EventCatalog
- ⭐ 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.

The generator requires the OpenAPI Generator.

1. Install the Amazon API Gateway Generator
2. Configure your generator in your eventcatalog.config.js file.
3. This will turn your API Gateway OpenAPI speciifcation files into EventCatalog ready files.
4. Install the OpenAPI Generator
5. Configure the OpenAPI generator to read and process files from your output of Amazon API Gateway Generator.
6. View your APIs, messages, services and domains in EventCatalog.

$3

This example:

1. Downloads the Store API from Amazon API Gateway
1. Hydrates the OpenAPI file with EventCatalog extensions
1. Outputs the generated OpenAPI files to amazon-apigateway-specs

1. Runs the OpenAPI generator
1. Processes the generated OpenAPI files into EventCatalog

``js
...
generators: [
[
'@eventcatalogtest/generator-amazon-apigateway',
{
output: 'amazon-apigateway-specs',
apis: [
{
name: 'Store API',
region: 'us-east-1',
stageName: 'prod',
routes: {
'post /users': {
type: 'command',
}
}
}
]
},
],
[
'@eventcatalogtest/generator-openapi',
{
services: [
{ path: [path.join(__dirname, 'amazon-apigateway-specs', 'Store API.json'), id: 'store' },
],
domain: { id: 'Shopping Cart', name: 'Shopping Cart', version: '0.0.1' },
},
],
],
...
`

Getting started

Installation and configuration

_Make sure you are on the latest version of EventCatalog_.

1. Install the packages

`sh
@eventcatalog/generator-amazon-apigateway
@eventcatalog/generator-openapi
`

2. Configure your eventcatalog.config.js file

- First configure the API Gateway Geneartor
- Then configure the OpenAPI generator

3. Run the generate command

`sh
npm run generate
`

4. See your new domains, services and messages, run

`sh
npm run dev
`

Found a problem?

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

[license-badge]: https://img.shields.io/github/license/event-catalog/eventcatalog.svg?color=yellow
[license]: https://github.com/event-catalog/eventcatalog/blob/main/LICENSE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: http://makeapullrequest.com
[github-watch-badge]: https://img.shields.io/github/watchers/event-catalog/eventcatalog.svg?style=social
[github-watch]: https://github.com/event-catalog/eventcatalog/watchers
[github-star-badge]: https://img.shields.io/github/stars/event-catalog/eventcatalog.svg?style=social
[github-star]: https://github.com/event-catalog/eventcatalog/stargazers

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 proprietary systems you must obtain a commercial license.

You can purchase a license or get a free trial at https://eventcatalog.cloud or email us at hello@eventcatalog.dev`