Getting started with schemas

EventCatalog is technically agnostic, meaning it can support any file format, specification format or schema format.

This means EventCatalog can document any schema format, including JSON, YAML, Avro, Protobuf, GraphQL, OpenAPI, AsyncAPI, etc.

Schemas are optional, but can provide valuable context and information about your messages and services.

If you add schemas to your messages and services, you can get some of these benefits:

• Quickly find schemas in the Schema Explorer
• Get access to your schemas through the EventCatalog API
• Ask questions about your schemas using the EventCatalog MCP
• Visualize your schemas with schema property search for your developers

Adding schemas to messages

Commands, Queries and Events can all have one or more schemas associated with them, you can read the documentation below to get started:

• Adding schemas to commands
• Adding schemas to queries
• Adding schemas to events

Adding specifications to services

Services can render AsyncAPI specifications, OpenAPI specifications and GraphQL schemas.

You can read the documentation below to get started:

• Adding AsyncAPI specifications to services
• Adding OpenAPI specifications to services
• Adding GraphQL schemas to services