Skip to content

Open-source tool to document, discover, and share your Amazon EventBridge schemas.

License

Notifications You must be signed in to change notification settings

boyney123/eventbridge-atlas

Repository files navigation

EventBridge Atlas 🗺

Document, Discover and Share Amazon EventBridge Schemas.

MIT License PRs Welcome

Watch on GitHub Star on GitHub


header

Features: Parses EventBridge schemas into documentation solutions, shows rules matched to your events, add metadata to each event property, support slate, AsyncAPI and docuowl output, and more...

Read the Docs | Edit the Docs


The problem

Event-Driven Architectures allow us to scale, be agile and keep our architecture decoupled. Ultimately I believe they help us work more efficiently.

When starting off with Event-Driven Architectures we spend time discovering our core business events, writing code to match them and maintain versions going forward.

Over a period of time more events are added to our domain, requirements change, and our architecture scales.

It can become difficult to know and understand what events are flowing within our domain.

I'm a huge fan of Amazon EventBridge and I wrote this tool to help engineers gain and keep an understanding of events that flow through their domain.

This solution

header

EventBridge atlas uses parsers t

EventBridge atlas uses a combination of open source tools to automatically generate documentation for engineers.

EventBridge Atlas downloads your schemas and parses them into various different outputs (you decide) and ouputs static HTML. So you can host your documentation anywhere!

You can read more on how it works on the website

Getting Started

You should be able to get setup within minutes if you head over to our documentation to get started 👇

➡️ Get Started

Examples

Here are some screenshots of examples of what EventBridge Atlas can produce using its parsers.

Your AWS Schemas are transformed into the following documentation tools:

Slate Parser

header

AsyncAPI Parser

header

Docuowl Parser

header

Tools

Documentation tools (Parsers)

Contributing

If you have any questions, features or issues please raise any issue or pull requests you like. I will try my best to get back to you.

Sponsor

Coming soon 👀

License

MIT.