Chapter 4. Getting started with Apicurio Registry


Apicurio Registry is a powerful tool for managing and storing data schemas, API designs, or any structured content in a centralized repository. It supports a wide variety of artifact types, including Avro, Protobuf, JSON Schema, and OpenAPI definitions.

Additional information

4.1. Exploring artifacts

Artifacts are the building blocks of Apicurio Registry. They represent data structures, API designs, or schema definitions stored in the registry for reuse and collaboration. You can upload, update, and retrieve artifacts, view their version history, and manage their lifecycle.

4.2. Managing groups

Groups allow you to organize artifacts logically, making it easier to manage and retrieve them. Each artifact belongs to a group, and groups can represent domains, projects, or teams. Grouping provides isolation while enabling fine-grained control over access and usage policies.

4.3. Managing rules

Rules in Apicurio Registry help enforce consistency and quality by validating artifacts against defined standards. You can apply global rules for the entire registry or configure specific rules for individual groups and artifacts.

4.4. Configuring settings

The configuration options in Apicurio Registry allow you to tailor the registry to your specific needs. Adjust operational parameters, integrate with external systems, or configure advanced settings to enhance performance and security.

4.5. Using the API

Apicurio Registry provides a robust REST API to interact with the registry programmatically. Developers can automate artifact management, integrate registry features into CI/CD pipelines, or build custom tools to enhance schema governance.

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.