4 posts tagged with "feature"

We are happy to announce that users can now use OpenAPI to help them document their services within EventCatalog!

This is a great feature from Rodolfo Toro ⭐️

This feature will allow you to easily display Swagger UI within EventCatalog in a few steps..

EventCatalog is focused on making Event Architecture documentation simple and useful. Having OpenAPI support for your services is another great reason to try out EventCatalog to help you document your Event Architectures.

How does EventCatalog work with OpenAPI?​

EventCatalog allows you to document your events, domains and services using Markdown and custom components.

We have now introduced a new component that allows you to display your OpenAPI spec files within any of your services.

You can add OpenAPI specification files to your services following these steps:

1. Add your openapi.yaml or openapi.json file into your service
   • example /services/{Your Service}/openapi.yaml
2. Add the Component OpenAPI inside your service markdown file.

This will load your OpenAPI file into your Service Page.

---
name: Payment Service
summary: |
  Event based application that integrates with Stripe.
owners:
  - dboyne
---

The payment service is our own internal payment service that listens to events from stripe and handles them within our own domain. 

We use Stripe to handle services and use this Payment service to enrich events for internal use.

<OpenAPI />

<NodeGraph />

Example Output​

How can you get started?​

If you already have EventCatalog then you will need to add the file openapi.yaml or openapi.json to your service folder. Then add the <OpenAPI /> component to your Markdown.

If you have yet to try EventCatalog, head over to our getting started guide, where you can get a catalog started within minutes using our NPM packages.

Summary​

This is a great feature from Rodolfo Toro and it is starting to show how the EventCatalog community is starting to grow!

Thank you Rodolfo Toro for your great contribution and we hope you all find it useful!

If you have any ideas or feedback feel free to raise an issue on GitHub or come join us on Discord.

Enjoy!

We are happy to announce that EventCatalog now supports domains.

This feature allows you to document domains and group events and services to them.

EventCatalog is focused on making Event Architecture documentation simple and useful. Grouping your events and services using domains makes it easier to maintain and describe your event architectures.

How do domains work?​

EventCatalog is designed to help you build Event Architecture Documentation using folders and markdown files. There are three main concepts to EventCatalog events, services and domains.

You can use EventCatalog to group your events and services using domains, and you can also create pages for your domains, helping you document them and use custom MDX components.

Adding domains can be done with some simple steps:

1. Create your domain folder /domains/{Your Domain}
   • example: /domains/Orders
2. Add details about your domain (title, summary, components)
   • example: /domains/Orders/index.md
3. Add events or services to your domain
   • event example: /domains/Orders/events/OrderCreated/index.md
   • service example: /domains/Orders/services/OrderCreated/index.md

EventCatalog uses markdown and the file system to help you encapsulate and document your domains.

How can you get started?​

If you already have EventCatalog and want to use the new domains feature checkout the migration guide

If you have yet to try EventCatalog, head over to our getting started guide, where you can get a catalog started within minutes using our NPM packages.

Summary​

EventCatalog was launched in January 2022 and so far we have had thousands of catalogs created, a great community building and some great momentum.

Supporing Domains in EventCatalog the top requested feature.

The project community provided some great feedback and ideas on how we could support domains and we are super excited and happy with the outcome!

Domains are a key core part of Event Architectures and we are super excited to now support them and help you document your event architectures.

If you have any ideas or feedback feel free to raise an issue on GitHub or come join us on Discord.

Enjoy!

We are happy to announce that the new visualiser feature has been released 🎉.

The visualiser allows you to see the relationships between all events, publishers and subscribers.

EventCatalog is focused on making Event Architecture documentation simple and useful. With the visualiser you will be able to understand the relationships between all your events and services.

How does the visualiser work?​

EventCatalog is powered by markdown files. Everything you see within the catalog is information written and stored within your markdown files. The visualiser parses your markdown files, understands the relationships between your events and services and can render node graphs based on your architecture.

If you want to add or remove publishers or subscribers you can simply edit your markdown files and instantly see the changes in your diagrams.

How can you get started?​

If you already have EventCatalog simply upgrade your @eventcatalog/core package to the latest and navigate to your visualiser. (new item in the navigation bar).

If you have yet to try EventCatalog head over to our getting started guide, where you can get a catalog started within minutes using our NPM packages.

Summary​

EventCatalog has only been out over a month so far and we have a great community providing feedback and using the catalog.

The visualiser feature was designed to help you and your team document your architectures and provide visual help to do that.

If you have any ideas or feedback feel free to raise an issue on GitHub or come join us on Discord.

Special thanks to Thim for making this feature possible with the introduction to Node Graphs without our MDX Components.

Enjoy!

Previously EventCatalog was using parts of NextJS that required a server to run (getServerSideProps) and NextJS API Route.

One of the top requests from the community was the ability to render EventCatalog as static content rather than having to run a server to host the catalog...

We are happy to announce that EventCatalog now exports static HTML an no longer requires a server to run!

What does this mean?​

When your run npm run build on EventCatalog it now bundles your content into static HTML using NextJS export feature.

This now means that EventCatalog can be hosted anywhere and no longer needs a server to run 🤩.

If you want to learn more you can read the deployment guide.

What about future features that require a server?​

We will see how EventCatalog code evolves, but if we need any features that require a server in the future, we can explore using feature switches and APIs to enable further enrichment of EventCatalog.

Thanks​

Shout out to @timhaselaars and @otbe for the ideas and code to help make this possible 🙏.

If you have any problems or further ideas for EventCatalog feel free to raise an issue or join our community on discord.

Enjoy!