5.3. Service Registry Maven プラグインを使用したアーティファクト参照の追加
Apache Avro、Google Protobuf、JSON スキーマなどの Service Registry アーティファクトタイプには、あるアーティファクトファイルから別のアーティファクトファイルへの アーティファクト参照 を含めることができます。再利用可能なスキーマまたは API アーティファクトを定義し、アーティファクト参照の複数の場所からそれらを参照することで、効率を高めることができます。
このセクションでは、Service Registry Maven プラグインを使用して、Service Registry に格納されている単純な Avro スキーマアーティファクトへのアーティファクト参照を登録する簡単な例を示します。この例では、次の Exchange
スキーマアーティファクトが Service Registry にすでに作成されていることを前提としています。
交換スキーマ
次に、この例では、ネストされた Exchange
スキーマアーティファクトへの参照を含む TradeKey
スキーマアーティファクトを作成します。
ネストされた Exchange スキーマを持つ TradeKey スキーマ
前提条件
- クライアントアプリケーションの Maven プロジェクトを作成しました。詳細については、Apache Maven のドキュメント を参照してください。
-
Exchange
スキーマアーティファクトは、Service Registry ですでに作成されています。
手順
apicurio-registry-maven-plugin
を使用してTradeKey
スキーマを登録するように Mavenpom.xml
ファイルを更新します。これには、次のようにExchange
スキーマへのネストされた参照が含まれます。Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
スキーマアーティファクトをレジストリーにアップロードするための実行目標として
register
を指定します。 -
../apis/registry/v2
エンドポイントでService Registry URL を指定します。 - 認証が必要な場合は、認証サーバーおよびクライアントの認証情報を指定できます。
-
Service Registry アーティファクトグループ ID を指定します。一意のグループ ID を使用しない場合は、
default
のグループを指定できます。 - グループ ID、アーティファクト ID、バージョン、タイプ、および場所を使用して、Service Registry アーティファクト参照を指定します。この方法で、複数のアーティファクト参照を登録できます。
-
スキーマアーティファクトをレジストリーにアップロードするための実行目標として
-
たとえば、
mvn package
コマンドを使用して、Maven プロジェクトをビルドします。