Chapter 5. Managing Service Registry content using the Maven plug-in

Procedure

• Update your Maven pom.xml file to use the apicurio-registry-maven-plugin to register an artifact. The following example shows registering Apache Avro and GraphQL schemas:

  <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>http://REGISTRY-URL/apis/registry/v2</registryUrl> 2
              <artifacts>
                  <artifact>
                      <groupId>TestGroup</groupId> 3
                      <artifactId>FullNameRecord</artifactId>
                      <file>${project.basedir}/src/main/resources/schemas/record.avsc</file>
                      <ifExists>FAIL</ifExists>
                  </artifact>
                  <artifact>
                      <groupId>TestGroup</groupId>
                      <artifactId>ExampleAPI</artifactId> 4
                      <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

  Specify register as the execution goal to upload the schema artifact to the registry.

  2

  Specify the Service Registry URL with the ../apis/registry/v2 endpoint.

  3

  Specify the Service Registry artifact group ID. You can specify the default group if you do not want to use a unique group.

  4

  You can upload multiple artifacts using the specified group ID, artifact ID, and location.

Procedure

• Update your Maven pom.xml file to use the apicurio-registry-maven-plugin to download an artifact. The following example shows downloading Apache Avro and GraphQL schemas.

  <plugin>
    <groupId>io.apicurio</groupId>
    <artifactId>apicurio-registry-maven-plugin</artifactId>
    <version>${apicurio.version}</version>
    <executions>
      <execution>
        <phase>generate-sources</phase>
        <goals>
          <goal>download</goal> 1
        </goals>
        <configuration>
            <registryUrl>http://REGISTRY-URL/apis/registry/v2</registryUrl> 2
            <artifacts>
                <artifact>
                    <groupId>TestGroup</groupId> 3
                    <artifactId>FullNameRecord</artifactId> 4
                    <file>${project.build.directory}/classes/record.avsc</file>
                    <overwrite>true</overwrite>
                </artifact>
                <artifact>
                    <groupId>TestGroup</groupId>
                    <artifactId>ExampleAPI</artifactId>
                    <version>1</version>
                    <file>${project.build.directory}/classes/example.graphql</file>
                    <overwrite>true</overwrite>
                </artifact>
            </artifacts>
        </configuration>
      </execution>
    </executions>
  </plugin>

  1

  Specify download as the execution goal.

  2

  Specify the Service Registry URL with the ../apis/registry/v2 endpoint.

  3

  Specify the Service Registry artifact group ID. You can specify the default group if you do not want to use a unique group.

  4

  You can download multiple artifacts to a specified directory using the artifact ID.

Procedure

• Update your Maven pom.xml file to use the apicurio-registry-maven-plugin to test an artifact. The following example shows testing an Apache Avro schema:

  <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>http://REGISTRY-URL/apis/registry/v2</registryUrl> 2
              <artifacts>
                  <artifact>
                      <groupId>TestGroup</groupId> 3
                      <artifactId>FullNameRecord</artifactId>
                      <file>${project.basedir}/src/main/resources/schemas/record.avsc</file> 4
                  </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>

  1

  Specify test-update as the execution goal to test the schema artifact.

  2

  Specify the Service Registry URL with the ../apis/registry/v2 endpoint.

  3

  Specify the Service Registry artifact group ID. You can specify the default group if you do not want to use a unique group.

  4

  You can test multiple artifacts from specified directory using the artifact ID.