Serialization and deserialization (SerDes) are critical functionalities within Apicurio Registry, enabling users to seamlessly manage schema evolution and compatibility. With the release of Apicurio Registry 3.x, we’ve significantly evolved our SerDes modules, focusing on flexibility, reusability, and broader integration.
With the release of Apicurio Registry 3.0.0.Final, we’ve significantly redesigned the configuration model to improve consistency and maintainability. If you’re upgrading from Registry 2.x, you’ll need to update your application properties to match the new format.
This guide provides a comprehensive walkthrough of all the changes and offers clear examples to ensure a smooth migration process.
Apicurio Registry 3.x is our latest and greatest release to date. It has plenty of new features but it also comes with some breaking changes from the previous 2.6.x release. In this post we will explore the process to migrate data from Apicurio Registry 2.6.x to Apicurio Registry 3.x.
Because of the breaking changes between 2.6.x and 3.x, there is no automatic upgrade and instead a migration process is required. But don’t worry! We promise the process is not hard.
In the world of API management, developer experience is paramount. Apicurio Registry 3.0 has taken a significant leap forward by implementing Kiota for automated SDK generation, making it easier than ever for developers to interact with the Registry’s Core REST API across multiple programming languages.
The release of Apicurio Registry 3.0 marks a significant milestone in our journey to provide the best possible Registry experience. With this major version update, we’ve taken the opportunity to implement several breaking changes to the Core REST API that both add powerful new functionality and streamline existing features.
Apicurio Registry 3.0 introduces a powerful new feature: support for automatic semantic versioning branches. This enhancement brings automatic branch management based on semantic versioning patterns, making it easier to organize, track, and access different versions of your schema artifacts. Let’s explore how this feature works and why it’s valuable for API governance.
If you’re using Confluent Schema Registry and looking to migrate your schemas to Apicurio Registry, you’re in luck! The Confluent Export Tool provides a simple way to export all schemas from a Confluent Schema Registry in a format that is directly importable into Apicurio Registry.
In this blog post, we’ll walk through what the tool does, how to use it, and some key considerations for a smooth migration.
Hey everyone - I would like to provide an update to the Apicurio community regarding the recent announcement from Red Hat:
In this post I will try to provide some context and explain how this change might impact us.
Hey everyone, in our previous blog post, we covered the authentication process using Azure Entra ID (formerly Azure AD).
In this technical guide, we will provide a step-by-step approach to securing both the Apicurio Registry UI and API. By the end, you’ll be ready to protect your Apicurio Registry using Azure Entra ID effectively. Let’s dive in!.
As promised in the announcement blog about the upcoming release of Apicurio Registry 3.0, this post is a deep dive into the changes we’re making to our Kafka storage variant. We’ll get into what the KafkaSQL storage variant is and why you might want to use it (pros and cons). And importantly, we’ll discuss the significant changes we’ve made to the implementation of this feature for 3.0.
Hey everyone - just dropping a quick blog post to let you know that we have released Apicurio Registry 3.0.0.M3. We’re working hard to get this new major release of Registry stable. This milestone 3 release is a huge step towards that goal. Very soon you can expect a 3.0.0.Final release, but please consider getting your feet wet now. We think 3.0 is ready for evaluation! (more below the fold)
Apicurio Registry allows to manage artifacts with references as shown in the documentation. One of the cool features we’ve added on top of this is the possibility of using a dereference parameter for certain API endpoints that optionally allows you to fetch the full content of an artifact with all the references inlined within the same content. This is especially useful in certain contexts to reduce the number of HTTP requests in the Kafka Serializers and Deserializers, as you will see in this blog.
The Apicurio Studio OpenAPI editor has been around for a long time, and over time support for vendor extensions has evolved somewhat. It started with:
"You can use the Source tab, good luck!"
Eventually we added a Vendor Extension section in various places, which made things a bit better. However, the UI was rather basic - just a list of the extensions with values displayed as raw JSON. Editing the values was also basic - simply a source editor for the raw JSON value of the extension.
We’ve made another incremental improvement in this area, which is to use form generation (via Formly) to generate a UI form used when editing the value of a vendor extension!
Are you looking for a tool that will make your work with Apicurio Registry easier? If you have Visual Studio Code installed, there is an extension that allows you to interact with Apicurio Registry directly from your IDE. This project was contributed to the Apicurio community by Jean-Etienne Martin. 🎉
We have a big announcement to make about Apicurio Studio that I hope some people will be interested in.
Studio has been languishing for quite some time without getting the attention it deserves from us (the maintainers/developers). But that is about to change!
We’re announcing the deprecation of Apicurio Studio 0.2 and the beginning of a new line of development for Apicurio Studio 1.0!
KafkaSQL is a popular storage option for Apicurio Registry, introduced in version 2.0.0.Final
. It has become very reliable, despite its higher complexity compared to the SQL storage option. Sadly, no software is immune to bugs, and KafkaSQL is no exception. On the other hand, bugs can be interesting, and the debugging process can provide a great opportunity to learn about Apicurio Registry and KafkaSQL internals. I’ve described one such bug in my previous blog post, titled Resolving a bug in KafkaSQL storage for Apicurio Registry.
A few days ago [1], an Apicurio Registry user reported that some of their Protobuf artifacts went missing after an upgrade from version 2.4.4.Final
to 2.5.5.Final
. They are using the KafkaSQL storage option, and after some investigation it turned out that other storage options are not affected. I’ve decided to write this article to explain the details, but if you are using KafkaSQL storage, please first jump to the Summary section to see if you might be at risk, and then read the Mitigation section for a list of actions you should take to mitigate the problem until we release a fixed version.
Hey everyone, in recent Apicurio Registry versions we’ve introduced support for securing the application using different OpenID Connect (OIDC) servers, and not just Keycloak. In this blog post, I will explain how to configure the application to secure it using Microsoft Azure Entra ID.
One of the major changes introduced in Apicurio Registry 2.x
were improvements in the supported storage options.
We have kept the possibility of using both PostgreSQL database and Kafka to store your data, but the internals of the
storage options have been improved, and in some ways simplified.
We have received great feedback from the users of the new KafkaSQL storage option, but recently several users have reported an interesting bug, that seems to only affect users with the KafkaSQL persistence enabled.
Apicurio Registry 2.x is our latest and greatest release to date. It has plenty of new features but it also comes with some breaking changes from the previous 1.3.x release. In this post we will explore the process to migrate data from Apicurio Registry 1.3.x to Apicurio Registry 2.x.
Because of the breaking changes between 1.3.x and 2.x, there is no automatic upgrade and instead a migration process is required. But don’t worry! We promise the process is not hard.
Hey everyone, in Apicurio Registry 2.0.0. Finally we’ve introduced support for some new security features. In this blog post, I will explain these concepts and show you how to configure them.
OMG we’ve released a new major version of Apicurio Registry! This post will provide an overview of what’s new in this latest release. Read on for details!
Hello everyone and welcome to the new Apicurio project blog! I know that Apicurio has been around for quite some time, and we even had a blog for a few months back at the start. We were so caught up in bootstrapping the project that we let the blog slip into disuse and ended up discarding it.
Well now it’s back! Or we’re here! Or whatever.