Kafka JSON Schema to Avro

Convert a JSON Schema to an Avro schema, with every keyword that has no Avro equivalent listed rather than dropped quietly. Most of them are the validation you are about to stop enforcing.

A JSON Schema has no namespace and Avro needs one for anything that will outlive the current version, so it is asked for here rather than left out. The title keyword is not used as the record name, because a title is prose and an Avro name is not.

Paste below, or drop a file anywhere on this panel

Or drop a file anywhere on this panel. Nothing is uploaded: the analysis runs in this tab.

The answer appears here

Paste on the left and press Convert. Nothing leaves this tab.

Examples

Real input you can load into the tool above. Each one shows a different thing going wrong, because that is what the tool is for.

An integer that must be a long

JSON Schema integer has no width, so it maps to long rather than int

{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id"]}

Optional fields

A property not in required becomes a nullable union with a null default

{"type":"object","properties":{"id":{"type":"integer"},"note":{"type":"string"}},"required":["id"]}

Common mistakes

These are the ones that fail silently. The config is accepted, nothing raises an error, and the consequence arrives later.

  1. Expecting integer to become int

    JSON Schema integer has no width, so the safe mapping is long. Choosing int silently overflows above two billion.

    Instead:Constrain with maximum if you want int, and say so.

  2. Assuming a JSON Schema union maps cleanly

    oneOf and anyOf are not Avro unions. Avro unions are ordered and resolved by position.

    Instead:Simplify the schema first, or hand-write the union.

  3. Skipping the namespace

    Avro records without a namespace collide in a registry as soon as two subjects share a record name.

    Instead:Set a namespace on every generated schema.

A validation language converted into a wire format

JSON Schema says what a document is allowed to be. Avro says what the bytes are. Most of the difference is things that stop being enforced, and every one of them is listed here rather than dropped quietly.

Every constraint keyword disappears

minimum, maximum, pattern, minLength, maxItems, uniqueItems and the rest have no Avro equivalent, because Avro describes an encoding and not a set of rules. After this conversion nothing in the schema or the serializer enforces any of them. That is not a shortcoming of the converter, it is what the two formats are, and the honest thing is to say which ones you just stopped enforcing.

Optional means something different in each

In JSON Schema a property is optional by being absent from required, and the key can simply not be there. Avro has no absent: every field is written. So an optional property becomes ["null", T] with a default of null, and null has to be the first branch because a union default belongs to the first branch. That shape is the only one that makes an Avro field genuinely optional.

// JSON Schema
"properties": {"note": {"type": "string"}},
"required": []

// Avro
{"name": "note",
 "type": ["null", "string"],
 "default": null}

integer becomes long unless the schema says it fits

JSON Schema's integer has no width. Avro's int is 32 bits and its long is 64, and choosing int for an unbounded integer produces a schema that fails to serialize the first large value. So long is the default here, and a maximum at or below 2147483647 gets you an int.

allOf, tuples and patternProperties have no equivalent at all

allOf is intersection and Avro has nothing that intersects two shapes. A tuple-typed array gives each position its own schema and an Avro array has one item type for every element, so it has to become a record with one field per position. patternProperties cannot be expressed: a map takes every string key or a record names them all, and there is nothing in between. Each of these is reported rather than approximated.

What this handles and what it does not

Draft-07 keywords, and $ref only within the pasted document: a reference to another file or a URL is not followed, because this page never fetches anything. A $ref cycle is cut and reported, since a recursive Avro type has to be written by hand. The generated schema is run back through our own Avro validator on every change, so anything unregistrable is reported here rather than by the registry.

More kafka tools

Kafka Confluent Wire Format Decoder The five junk bytes in front of your payload Kafka Key to Partition Mapper Which partition does this key land on? Kafka Topic Name Validator Legal, risky, or 249 characters too long? Kafka Replication Safety Checker How many brokers can you lose Kafka Producer Config Linter Will it start, and will it lose a record? Kafka Message Payload Decoder The first five bytes are usually not data Kafka Connect Source Connector Generator tasks.max is a ceiling, not a count Kafka Connect Sink Connector Generator A dead letter queue with no context headers is a pile of records Kafka Connect SMT Chain Builder The order is the transforms list Kafka MirrorMaker 2 Config Generator It renames every topic by default Kafka Partition Reassignment Generator The throttle is not optional Strimzi Kafka Resource Generator Without the cluster label, nothing happens Kafka mTLS Config Generator The certificate is the identity Kafka Schema Registry Config Generator The compatibility direction is your deployment order Kafka Exactly-Once Config Generator Half of it is worse than none Kafka Broker and KRaft Config Generator The internal topics that break a one-broker cluster Kafka Quota Generator Byte rates are per broker, not per cluster Kafka Streams Config Generator application.id is four things at once Kafka Connect Worker Config Generator Security three times, or the tasks fail Kafka Retention and Unit Converter log.retention.hours does not take milliseconds Kafka Timestamp Converter Two sentinels and two meanings Kafka .properties to YAML Converter Dotted keys stay flat Kafka Streams Internal Topic Predictor Create them before Streams does Kafka ACL Generator The grant you forgot is on another resource type Kafka Topic Config Generator min.insync.replicas is the one that matters Kafka client.properties Generator The file every CLI tool asks for Kafka Producer Config Generator No password field, on purpose Kafka Consumer Config Generator The commit mode decides the semantics Kafka Disk and Retention Calculator retention.bytes is per partition Kafka Partition Count Calculator The number you can never reduce Kafka Cluster Sizing Calculator The traffic no client metric shows Kafka Consumer Lag Catch-Up Calculator Whether it ever clears, not just when Kafka Producer Batching Calculator linger.ms=0 still batches Kafka Segment and Index Sizing Why retention.ms is a lower bound Kafka Rebalance Duration Estimator What a rolling restart really costs Kafka Cost Estimator Your rates, so nothing goes stale Kafka Config Explorer by Version The answer depends on the release Kafka Default Config Reference What moved under a config you never edited Kafka OAuth Bearer Token Decoder Will Kafka accept it, and can it refresh Kafka Record Header Viewer Headers are a list, not a map Kafka Topic Regex Subscription Tester Kafka matches the whole name Kafka ACL Permission Matrix Viewer DENY beats every ALLOW Kafka Connect Config Validator The mistakes that raise no error Kafka Consumer Group Id Validator Which broker coordinates the group Kafka Partition Assignment Visualizer Leadership is the load, not replicas Kafka Consumer Assignment Visualizer The three assignors disagree Kafka ZooKeeper to KRaft Config Converter The authorizer class nobody changes Kafka Config to Strimzi Half of it belongs elsewhere Kafka Docker Compose Generator (KRaft) Reachable from inside and outside Kafka JAAS Config Decoder The line that stops SASL working Kafka CRC32C Calculator Which CRC, over which bytes Kafka Config Upgrade Checker What breaks when you upgrade Kafka Kafka Config Diff Which change actually changed something Kafka Consumer Config Linter Why the group rebalances, and where the records went Kafka Avro Schema Validator The defaults Avro accepts and rejects Kafka Schema Compatibility Checker What the registry will say, before you ask it Kafka Avro Schema Diff Which direction each change breaks Kafka Compression Comparison Measured on your bytes Kafka Delivery Semantics Exactly-once has a consumer half Kafka ksqlDB Query Builder It looks like SQL and the rules are not Kafka Connect SMT Predicate Tester negate reads backwards Kafka Streams Topology Viewer Count the repartitions Kafka Connect Pipeline Visualizer The order things really run in Kafka Protobuf Binary Decoder Works without the .proto Kafka Protobuf JSON Converter Why your JSON does not round-trip Kafka Protobuf to Avro Schema What does not survive the conversion Kafka Avro Binary Decoder Wrong schema, no error Kafka Avro JSON Converter Why the console producer rejects your line Kafka Avro Sample Data Generator Records that actually serialize Kafka JSON to Avro Schema What JSON cannot tell you Kafka SASL JAAS Generator One login module, four syntaxes Kafka CLI Command Builder kcat is librdkafka, not Kafka

Elsewhere on the site