第5章 Maven プラグインを使用した Apicurio Registry コンテンツの管理

手順

1. Maven pom.xml ファイルを更新して、 apicurio-registry-maven-plugin を使用してアーティファクトを登録します。以下の例は、Apache Avro および GraphQL スキーマの登録を示しています。

   <plugin>
     <groupId>io.apicurio</groupId>
     <artifactId>apicurio-registry-maven-plugin</artifactId>
     <version>${apicurio.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>TestGroup</groupId> 4
                       <artifactId>FullNameRecord</artifactId>
                       <file>${project.basedir}/src/main/resources/schemas/record.avsc</file>
                       <ifExists>FAIL</ifExists>
                   </artifact>
                   <artifact>
                       <groupId>TestGroup</groupId>
                       <artifactId>ExampleAPI</artifactId> 5
                       <type>GRAPHQL</type>
                       <file>${project.basedir}/src/main/resources/apis/example.graphql</file>
                       <ifExists>RETURN_OR_UPDATE</ifExists>
                       <canonicalize>true</canonicalize>
                   </artifact>
               </artifacts>
           </configuration>
       </execution>
     </executions>
    </plugin>

   1. register を実行ゴールとして指定し、スキーマアーティファクトを Apicurio Registry にアップロードします。
   2. ../apis/registry/v2 エンドポイントで Apicurio Registry URL を指定します。
   3. 認証が必要な場合は、認証サーバーおよびクライアントの認証情報を指定できます。
   4. Apicurio Registry アーティファクトグループ ID を指定します。一意のグループ ID を使用しない場合は、default のグループを指定できます。
   5. 指定したグループ ID、アーティファクト ID、および場所を使用して複数のアーティファクトを登録できます。
2. たとえば、mvn package コマンドを使用して、Maven プロジェクトをビルドします。