5.4. Maven プラグインを使用したスキーマおよび API アーティファクトのテスト
実際にアーティファクトを変更せずに、アーティファクトをが登録できることを確認する場合があります。これは、ルールが Service Registry に設定されている場合に役に立ちます。アーティファクトのコンテンツが設定済みのルールのいずれかに違反する場合、アーティファクトのテストに失敗します。
注記
Maven プラグインを使用してアーティファクトをテストする場合には、アーティファクトがテストに合格しても、Service Registry にコンテンツが追加されません。
前提条件
- Service Registry が環境にインストールされ、実行されている。
手順
Maven pom.xml ファイルを更新して、 apicurio-registry-maven-plugin を使用してアーティファクトをテストします。Apache Avro スキーマのテストの例を以下に示します。
<plugin>
<groupId>io.apicurio</groupId>
<artifactId>apicurio-registry-maven-plugin</artifactId>
<version>${apicurio.version}</version>
<executions>
<execution>
<phase>generate-sources</phase>
<goals>
<goal>test-update</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>TestGroup</groupId> 4
<artifactId>FullNameRecord</artifactId>
<file>${project.basedir}/src/main/resources/schemas/record.avsc</file> 5
</artifact>
<artifact>
<groupId>TestGroup</groupId>
<artifactId>ExampleAPI</artifactId>
<type>GRAPHQL</type>
<file>${project.basedir}/src/main/resources/apis/example.graphql</file>
</artifact>
</artifacts>
</configuration>
</execution>
</executions>
</plugin>-
スキーマアーティファクトをテストするための実行目標として
test-updateを指定します。 -
../apis/registry/v2エンドポイントでService Registry URL を指定します。 - 認証が必要な場合は、認証サーバーおよびクライアントの認証情報を指定できます。
-
Service Registry アーティファクトグループ ID を指定します。一意のグループを使用しない場合は、
defaultのグループを指定できます。 - アーティファクト ID を使用すると、指定のディレクトリーから複数のアーティファクトをテストできます。