5.3. Apicurio Registry Maven プラグインを使用して成果物参照を追加する
Apache Avro、Google Protobuf、JSON スキーマなどの Apicurio Registry アーティファクトタイプには、あるアーティファクトファイルから別のアーティファクトファイルへの アーティファクト参照 を含めることができます。再利用可能なスキーマまたは API アーティファクトを定義し、アーティファクト参照の複数の場所からそれらを参照することで、効率を高めることができます。
このセクションでは、Apicurio Registry Maven プラグインを使用して、Apicurio Registry に格納されている単純な Avro スキーマアーティファクトへのアーティファクト参照を登録する簡単な例を示します。この例では、次の Exchange
スキーマアーティファクトが Apicurio Registry にすでに作成されていることを前提としています。
交換スキーマ
{ "namespace": "com.kubetrade.schema.common", "type": "enum", "name": "Exchange", "symbols" : ["GEMINI"] }
次に、この例では、ネストされた Exchange
スキーマアーティファクトへの参照を含む TradeKey
スキーマアーティファクトを作成します。
ネストされた Exchange スキーマを持つ TradeKey スキーマ
{ "namespace": "com.kubetrade.schema.trade", "type": "record", "name": "TradeKey", "fields": [ { "name": "exchange", "type": "com.kubetrade.schema.common.Exchange" }, { "name": "key", "type": "string" } ] }
前提条件
- クライアントアプリケーションの Maven プロジェクトを作成しました。詳細については、Apache Maven のドキュメント を参照してください。
-
Exchange
スキーマアーティファクトは、Apicurio Registry ですでに作成されています。
手順
apicurio-registry-maven-plugin
を使用してTradeKey
スキーマを登録するように Mavenpom.xml
ファイルを更新します。これには、次のようにExchange
スキーマへのネストされた参照が含まれます。<plugin> <groupId>io.apicurio</groupId> <artifactId>apicurio-registry-maven-plugin</artifactId> <version>${apicurio-registry.version}</version> <executions> <execution> <phase>generate-sources</phase> <goals> <goal>register</goal> 1 </goals> <configuration> <registryUrl>MY-REGISTRY-URL/apis/registry/v2</registryUrl> 2 <authServerUrl>MY-AUTH-SERVER</authServerUrl> <clientId>MY-CLIENT-ID</clientId> <clientSecret>MY-CLIENT-SECRET</clientSecret> 3 <artifacts> <artifact> <groupId>test-group</groupId> 4 <artifactId>TradeKey</artifactId> <version>2.0</version> <type>AVRO</type> <file> ${project.basedir}/src/main/resources/schemas/TradeKey.avsc </file> <ifExists>RETURN_OR_UPDATE</ifExists> <canonicalize>true</canonicalize> <references> <reference> 5 <name>com.kubetrade.schema.common.Exchange</name> <groupId>test-group</groupId> <artifactId>Exchange</artifactId> <version>2.0</version> <type>AVRO</type> <file> ${project.basedir}/src/main/resources/schemas/Exchange.avsc </file> <ifExists>RETURN_OR_UPDATE</ifExists> <canonicalize>true</canonicalize> </reference> </references> </artifact> </artifacts> </configuration> </execution> </executions> </plugin>
-
スキーマアーティファクトをレジストリーにアップロードするための実行目標として
register
を指定します。 -
../apis/registry/v2
エンドポイントで Apicurio Registry URL を指定します。 - 認証が必要な場合は、認証サーバーおよびクライアントの認証情報を指定できます。
-
Apicurio Registry アーティファクトグループ ID を指定します。一意のグループ ID を使用しない場合は、
default
のグループを指定できます。 - グループ ID、アーティファクト ID、バージョン、タイプ、および場所を使用して、Apicurio Registry アーティファクト参照を指定します。この方法で、複数のアーティファクト参照を登録できます。
-
スキーマアーティファクトをレジストリーにアップロードするための実行目標として
-
たとえば、
mvn package
コマンドを使用して、Maven プロジェクトをビルドします。
関連情報
- Apache Maven の使用の詳細については、Apache Maven のドキュメント を参照してください。
- Apicurio Registry Maven プラグインを使用したオープンソースの例については、Apicurio Registry のデモンストレーションの例 を参照してください。
- アーティファクト参照のその他の例については、8章Java クライアントでの Kafka シリアライザー/デシリアライザーの設定 の各アーティファクトタイプの設定に関するセクションを参照してください。