第 5 章 使用 Maven 插件管理 Service Registry 内容
本章论述了如何使用 Service Registry Maven 插件管理 registry 中存储的架构和 API 工件:
前提条件
- 请查看 第 1 章 Service Registry 简介
- 在您的环境中必须安装并运行服务 Registry
- 在您的环境中必须安装并配置了 Maven
5.1. 使用 Maven 插件添加 schema 和 API 工件
Maven 插件的最常见用例是在构建期间添加工件。您可以使用 注册
执行目标来实现此目的。
前提条件
- Service Registry 在您的环境中安装并运行
流程
更新 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>
-
指定
register
作为执行目标,以便将 schema 构件上传到 registry。 -
使用 ./
apis/registry/v2
端点指定 Service Registry URL。 - 如果需要身份验证,您可以指定身份验证服务器和客户端凭证。
-
指定 Service Registry 工件组 ID。如果您不想使用唯一组 ID,可以指定
default
组。 - 您可以使用指定的组 ID、工件 ID 和位置来注册多个工件。