Managing Apicurio Registry content using the Maven plug-in

You can use the Apicurio Registry Maven plug-in to manage schema and API artifacts stored in Apicurio Registry when developing client applications:

Adding schema and API artifacts using the Maven plug-in
Downloading schema and API artifacts using the Maven plug-in
Adding artifact references using the Apicurio Registry Maven plug-in
Testing schema and API artifacts using the Maven plug-in

Prerequisites

Apicurio Registry is installed and running in your environment.
Apache Maven is 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 of your client application. You can accomplish this by using the register execution goal.

Prerequisites

You have created a Maven project for your client application. For more details, see the Apache Maven documentation.

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>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>

Specify register as the execution goal to upload the schema artifact to Apicurio Registry.
Specify the Apicurio Registry URL with the ../apis/registry/v2 endpoint.
If authentication is required, you can specify your authentication server and client credentials.
Specify the Apicurio Registry artifact group ID. You can specify the default group if you do not want to use a unique group ID.
You can register multiple artifacts using the specified group ID, artifact ID, and location.

Build your Maven project, for example, by using the mvn package command.

Additional resources

For more details on using Apache Maven, see the Apache Maven documentation.
For open source examples of using the Apicurio Registry Maven plug-in, see the Apicurio Registry demonstration examples.

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.

Prerequisites

You have created a Maven project for your client application. For more details, see the Apache Maven documentation.

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>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> (5)
                  <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>

Specify download as the execution goal.
Specify the Apicurio Registry URL with the ../apis/registry/v2 endpoint.
If authentication is required, you can specify your authentication server and client credentials.
Specify the Apicurio Registry artifact group ID. You can specify the default group if you do not want to use a unique group.
You can download multiple artifacts to a specified directory using the artifact ID.

Build your Maven project, for example, by using the mvn package command.

Additional resources

For more details on using Apache Maven, see the Apache Maven documentation.
For open source examples of using the Apicurio Registry Maven plug-in, see the Apicurio Registry demonstration examples.

Adding artifact references using the Apicurio Registry Maven plug-in

Apicurio Registry artifact types such as Apache Avro, Google Protobuf, and JSON Schema can include artifact references from one artifact file to another. You can create efficiencies by defining reusable schema or API artifacts, and then referencing them from multiple locations in artifact references.

This section shows a simple example of using the Apicurio Registry Maven plug-in to register an artifact reference to a simple Avro schema artifact stored in Apicurio Registry. This example assumes that the following Exchange schema artifact has already been created in Apicurio Registry:

Exchange schema

{
  "namespace": "com.kubetrade.schema.common",
  "type": "enum",
  "name": "Exchange",
  "symbols" : ["GEMINI"]
}

This example then creates a TradeKey schema artifact, which includes a reference to the nested Exchange schema artifact:

TradeKey schema with nested Exchange schema

{
  "namespace": "com.kubetrade.schema.trade",
  "type": "record",
  "name": "TradeKey",
  "fields": [
    {
      "name": "exchange",
      "type": "com.kubetrade.schema.common.Exchange"
    },
    {
      "name": "key",
      "type": "string"
    }
  ]
}

Prerequisites

You have created a Maven project for your client application. For more details, see the Apache Maven documentation.
The Exchange schema artifact is already created in Apicurio Registry.

Procedure

Update your Maven pom.xml file to use the apicurio-registry-maven-plugin to register the TradeKey schema, which includes a nested reference to the Exchange schema as follows:

<plugin>
    <groupId>io.apicurio</groupId>
    <artifactId>apicurio-registry-maven-plugin</artifactId>
    <version>${apicurio-registry.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>test-group</groupId> (4)
                        <artifactId>TradeKey</artifactId>
                        <version>2.0</version>
                        <type>AVRO</type>
                        <file>
                            ${project.basedir}/src/main/resources/schemas/TradeKey.avsc
                        </file>
                        <ifExists>RETURN_OR_UPDATE</ifExists>
                        <canonicalize>true</canonicalize>
                        <references>
                            <reference> (5)
                                <name>com.kubetrade.schema.common.Exchange</name>
                                <groupId>test-group</groupId>
                                <artifactId>Exchange</artifactId>
                                <version>2.0</version>
                                <type>AVRO</type>
                                <file>
                                    ${project.basedir}/src/main/resources/schemas/Exchange.avsc
                                </file>
                                <ifExists>RETURN_OR_UPDATE</ifExists>
                                <canonicalize>true</canonicalize>
                            </reference>
                        </references>
                    </artifact>
                </artifacts>
            </configuration>
        </execution>
    </executions>
</plugin>

Specify register as the execution goal to upload the schema artifact to the registry.
Specify the Apicurio Registry URL with the ../apis/registry/v2 endpoint.
If authentication is required, you can specify your authentication server and client credentials.
Specify the Apicurio Registry artifact group ID. You can specify the default group if you do not want to use a unique group ID.
Specify the Apicurio Registry artifact reference using its group ID, artifact ID, version, type, and location. You can register multiple artifact references in this way.

Build your Maven project, for example, by using the mvn package command.

Additional resources

For more details on using Apache Maven, see the Apache Maven documentation.
For open source examples of using the Apicurio Registry Maven plug-in, see the Apicurio Registry demonstration examples.
For more examples of artifact references, see the section on configuring each artifact type in Kafka client serializers/deserializers in Java clients.

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.

When testing artifacts using the Maven plug-in, even if the artifact passes the test, no content is added to Apicurio Registry.

Prerequisites

You have created a Maven project for your client application. For more details, see the Apache Maven documentation.

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>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>
            </artifacts>
        </configuration>
    </execution>
  </executions>
 </plugin>

Specify test-update as the execution goal to test the schema artifact.
Specify the Apicurio Registry URL with the ../apis/registry/v2 endpoint.
If authentication is required, you can specify your authentication server and client credentials.
Specify the Apicurio Registry artifact group ID. You can specify the default group if you do not want to use a unique group.
You can test multiple artifacts from a specified directory using the artifact ID.

Build your Maven project, for example, by using the mvn package command.

Additional resources

For more details on using Apache Maven, see the Apache Maven documentation.
For open source examples of using the Apicurio Registry Maven plug-in, see the Apicurio Registry demonstration examples.