Getting started with schemas
EventCatalog supports any schema or specification format, including (but not limited to):
- JSON / YAML
- Avro
- Protobuf
- GraphQL
- OpenAPI
- AsyncAPI
Schemas are optional, but they add valuable context to your messages and services by making data structures explicit and discoverable.
Why add schemas?​
By adding schemas to your messages and services, you unlock several benefits:
- Schema Explorer – Quickly find and browse schemas (see demo)
- API access – Access schemas programmatically through the EventCatalog API (see guide)
- Ask questions – Query and explore schemas using the EventCatalog MCP
- Visualization – Help developers understand data structures using schema property search and visualization
Adding schemas to messages​
You can attach one or more schemas to any message type:
- Commands -
- Queries
- Events
Get started by following the relevant guide:
Adding specifications to services​
In addition to message-level schemas, services can render full API and messaging specifications, including:
- AsyncAPI
- OpenAPI
- GraphQL
Use the guides below to add specifications to your services: