第1章 Service Registry の概要

イベントスキーマや API 仕様などの Service Registry に保存される項目は アーティファクト と呼ばれます。以下は、単純な株価アプリケーションの JSON 形式の Apache Avro スキーマアーティファクトの例を示しています。

{
   "type": "record",
   "name": "price",
   "namespace": "com.example",
   "fields": [
       {
           "name": "symbol",
           "type": "string"
       },
       {
           "name": "price",
           "type": "string"
       }
   ]
}

{
   "type": "record",
   "name": "price",
   "namespace": "com.example",
   "fields": [
       {
           "name": "symbol",
           "type": "string"
       },
       {
           "name": "price",
           "type": "string"
       }
   ]
}

スキーマまたは API 契約がレジストリーのアーティファクトとして追加されると、クライアントアプリケーションはそのスキーマまたは API 契約を使用して、実行時にクライアントメッセージが正しいデータ構造に準拠することを確認できます。

Service Registry は、標準のイベントスキーマおよび API 仕様の幅広いメッセージペイロード形式をサポートしています。たとえば、サポートされている形式には、Apache Avro、Google プロトコルバッファー、GraphQL、AsyncAPI、OpenAPI などがあります。詳細は、「サポートされるアーティファクトタイプ」 を参照してください。

Registry REST API を使用すると、クライアントアプリケーションは Service Registry のアーティファクトを管理できます。この API では、以下を行うために作成、読み取り、更新、および削除の操作が提供されます。

詳細は、Apicurio Registry REST API のドキュメント を参照してください。

Service Registry は、アーティファクトの以下の基礎となるストレージ実装をサポートします。

イベントベースのプロデューサーアプリケーションは、シリアライザーを使用して、特定のイベントスキーマに準拠するメッセージをエンコードできます。コンシューマーアプリケーションはデシリアライザーを使用して、特定のスキーマ ID に基づいてメッセージが適切なスキーマを使用してシリアライズされたことを検証できます。Service Registry は、クライアントシリアライザー/デシリアライザーを提供し、実行時に以下のメッセージタイプを検証します。

Service Registry Maven リポジトリーおよびソースコードディストリビューションには、これらのメッセージタイプのシリアライザー/デシリアライザー実装が含まれます。クライアント開発者がレジストリーと統合するために使用できます。これらの実装には、サポートされる各メッセージタイプにカスタム io.apicurio.registry.utils.serde Java クラスが含まれ、クライアントアプリケーションが検証用に実行時にレジストリーからスキーマをプルするために使用できます。

Service Registry は、Apache Kafka Streams のストレージを使用した Apache Avro シリアライゼーション/デシリアライゼーションのオープンソースのデモ例を提供します。以下の例は、シリアライザー/デシリアライザーが実行時にレジストリーから Avro スキーマを取得し、これを使用して Kafka メッセージをシリアライズおよびデシリアライズする方法を示しています。詳細は、https://github.com/Apicurio/apicurio-registry-demo を参照してください。

このデモでは、Apache Kafka のストレージを使用した Avro および JSON スキーマのシリアライズ/デシリアライズの両方に関する簡単な例も含まれています( https://github.com/Apicurio/apicurio-registry-demo/tree/master/src/main/java/io/apicurio/registry/demo/simple)。

Apache Kafka のストレージを使用した Avro シリアライゼーション/デシリアライゼーションの詳細は、『 Getting Started with Red Hat Integration Service Registry 』の「Red Hat Developer」の記事を参照してください。