1.2. Apicurio Registry のスキーマと API アーティファクト

アーティファクトのバージョン

すべてのアーティファクトには、0 個以上の _artifact version_s があります。実際のコンテンツ (およびメタデータ) が含まれるのは、アーティファクトバージョンのみです。これらのバージョンはアーティファクトのコンテンツの進化を表し、イミュータブルです。アーティファクトは、バージョンの順序付けられたシーケンスと考えることができます。通常、最新バージョンがスキーマまたは API 設計コンテンツの「最新状態」を表します。

アーティファクトバージョンには、生成されたメタデータと編集可能なメタデータの両方が含まれます。アーティファクトの標準メタデータには、以下が含まれます (ただし、これらに限定されません)。

スキーマと API のグループ

アーティファクトグループ は、スキーマまたは API アーティファクトのオプションの名前付きコレクションです。各グループには、論理的に関連したスキーマまたは API 設計のセットが含まれており、通常、特定のアプリケーションまたは組織に属する単一のエンティティーにより管理されます。

スキーマと API 設計を追加して Apicurio Registry で整理するときに、オプションのアーティファクトグループを作成できます。たとえば、development および production アプリケーション環境、あるいは sales および engineering 組織に一致するグループを作成できます。

スキーマおよび API グループには複数のアーティファクトタイプを含めることができます。たとえば、Protobuf、Avro、JSON スキーマ、OpenAPI、または AsyncAPI アーティファクトをすべて同じグループに含めることができます。

グループには、生成されたメタデータと編集可能なメタデータの両方があります。グループの標準メタデータには、以下が含まれます (ただし、これらに限定されません)。

Apicurio Registry Web コンソール、REST API、コマンドライン、Maven プラグイン、または Java クライアントアプリケーションを使用して、スキーマおよび API アーティファクトとグループを作成できます。

他のスキーマと API への参照

一部の Apicurio Registry アーティファクトタイプには、あるアーティファクトファイルから別のアーティファクトファイルへの アーティファクト参照 を含めることができます。再利用可能なスキーマまたは API コンポーネントを定義し、それらを複数の場所から参照して効率を高めることができます。たとえば、$ref ステートメントを使用して JSON スキーマまたは OpenAPI で参照を指定したり、import ステートメントを使用して Google Protobuf で参照を指定したり、ネストされた名前空間を使用して Apache Avro で参照を指定したりできます。

次の例は、ネストされた名前空間を使用して Exchange という名前の別のスキーマへの参照を含む、TradeKey という名前の単純な Avro スキーマを示しています。

{
 "namespace": "com.kubetrade.schema.trade",
 "type": "record",
 "name": "TradeKey",
 "fields": [
   {
     "name": "exchange",
     "type": "com.kubetrade.schema.common.Exchange"
   },
   {
     "name": "key",
     "type": "string"
   }
 ]
}

{
 "namespace": "com.kubetrade.schema.trade",
 "type": "record",
 "name": "TradeKey",
 "fields": [
   {
     "name": "exchange",
     "type": "com.kubetrade.schema.common.Exchange"
   },
   {
     "name": "key",
     "type": "string"
   }
 ]
}

{
 "namespace": "com.kubetrade.schema.common",
 "type": "enum",
 "name": "Exchange",
 "symbols" : ["GEMINI"]
}

{
 "namespace": "com.kubetrade.schema.common",
 "type": "enum",
 "name": "Exchange",
 "symbols" : ["GEMINI"]
}

アーティファクト参照は、アーティファクトタイプ固有の参照から内部 Apicurio Registry 参照にマップされるアーティファクトメタデータのコレクションとして Apicurio Registry に格納されます。Apicurio Registry の各成果物参照は、次のもので構成されています。

Apicurio Registry コア REST API、Maven プラグイン、および Java シリアライザー/デシリアライザー (SerDes) を使用して、アーティファクト参照を管理できます。Apicurio Registry は、アーティファクトリーファレンスをアーティファクトコンテンツと共に保存します。Apicurio Registry は、すべてのアーティファクトリーファレンスのコレクションも保持しているため、コレクションを検索したり、特定のアーティファクトのすべてのリファレンスを一覧表示したりできます。

サポートされているアーティファクトタイプ

Apicurio Registry は現在、次のアーティファクトタイプのアーティファクトリーファレンスのみをサポートしています。