A central, versioned home for the schemas and API designs that hold a distributed system together.

Welcome to Apicurio Registry: Governing Schemas and APIs at Runtime.

Apicurio Registry is a high-performance, runtime registry for storing and managing the schemas and API designs that define how services talk to one another — Avro, Protobuf, JSON Schema, OpenAPI, AsyncAPI, GraphQL, and WSDL/XSD. In an event-driven world where a single bad schema change can break every consumer downstream, it gives teams one trusted place to publish contracts, version them, search them, and enforce rules about how they are allowed to evolve. This book begins with the contract problem that motivates a registry, then builds up its data model of groups, artifacts, and versions, its content rules for validity and compatibility, and its pluggable storage. From there it moves into the Core REST API and the Confluent-compatible API, the Kafka serializers and deserializers that wire the registry into real producers and consumers, and finally how to deploy, secure, and operate it in production. Each chapter favors clear prose and concrete examples over hand-waving.

This title is part of the ShriIra library and is free to read in full, right here — our small contribution to making world-class knowledge easy to reach.

A note on reading it: open the Contents menu at the top of the reader to jump between chapters, use the Aa menu to set a comfortable text size, theme (light, sepia, or night), and single- or two-page layout. Your place is saved automatically, so you can always pick up where you left off.

We hope it serves you well.

— Shriira Press

Contents

1. Chapter 1 — The Contract Problem
2. Chapter 2 — Groups, Artifacts, and Versions
3. Chapter 3 — Artifact Types and References
4. Chapter 4 — Content Rules and Compatibility
5. Chapter 5 — Storage and Architecture
6. Chapter 6 — The REST APIs and Console
7. Chapter 7 — Kafka SerDes Integration
8. Chapter 8 — Deploying and Operating in Production