Managing Apicurio Registry content using the Maven plug-in

This chapter explains how to manage schema and API artifacts stored in the registry using the Apicurio Registry Maven plug-in:

Prerequisites

  • See Introduction to Apicurio Registry

  • Apicurio Registry must be installed and running in your environment

  • Maven must be installed and configured in your environment

Adding schema and API artifacts using the Maven plug-in

The most common use case for the Maven plug-in is adding artifacts during a build. You can accomplish this by using the register execution goal.

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 Apicurio Registry URL with the ../apis/registry/v2 endpoint.
    3 Specify the Apicurio 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.
Additional resources

Downloading schema and API artifacts using the Maven plug-in

You can use the Maven plug-in to download artifacts from Apicurio Registry. This is often useful, for example, when generating code from a registered schema.

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 Apicurio Registry URL with the ../apis/registry/v2 endpoint.
    3 Specify the Apicurio 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.
Additional resources

Testing schema and API artifacts using the Maven plug-in

You might want to verify that an artifact can be registered without actually making any changes. This is often useful when rules are configured in Apicurio Registry. Testing the artifact results in a failure if the artifact content violates any of the configured rules.

Even if the artifact passes the test, no content is added to Apicurio Registry.
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 Apicurio Registry URL with the ../apis/registry/v2 endpoint.
    3 Specify the Apicurio 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.
Additional resources