4.2. 使用 Service Registry REST API 命令管理 schema 和 API 工件版本
如果您没有在使用 v2 核心 REST API 添加 schema 和 API 工件到 Service Registry 时指定工件版本,Service Registry 会自动生成一个。创建新工件时的默认版本为 1
。
Service Registry 还支持自定义版本,您可以在其中使用 X-Registry-Version
HTTP 请求标头作为字符串来指定版本。指定自定义版本值会覆盖通常会在创建或更新工件时分配的默认版本。然后,您可以在执行需要版本的 REST API 操作时使用此版本值。
本节演示了一个简单的基于 curl 的示例,它使用 registry v2 核心 REST API 添加和检索 registry 中的自定义 Apache Avro 模式版本。在使用 REST API 添加或更新工件或添加工件版本时,可以指定自定义版本。
先决条件
- Service Registry 在您的环境中安装并运行
流程
使用
/groups/{group}/artifacts
操作在 registry 中添加工件版本。以下示例curl
命令为共享价格应用程序添加一个简单的工件:$ curl -X POST -H "Content-Type: application/json; artifactType=AVRO" \ -H "X-Registry-ArtifactId: my-share-price" -H "X-Registry-Version: 1.1.1" \ -H "Authorization: Bearer $ACCESS_TOKEN" \ --data '{"type":"record","name":" p","namespace":"com.example", \ "fields":[{"name":"symbol","type":"string"},{"name":"price","type":"string"}]}' \ MY-REGISTRY-URL/apis/registry/v2/groups/my-group/artifacts
-
这个示例添加了一个 Avro 模式工件 ID,其工件 ID 为
my-share-price
和1.1.1
版本。如果没有指定版本,Service Registry 会自动生成默认版本1
。 -
MY-REGISTRY-URL
是在其上部署 Service Registry 的主机名。例如:my-cluster-service-registry-myproject.example.com
。 -
本例在 API 路径中指定
my-group
的组 ID。如果没有指定唯一组 ID,则必须在 API 路径中指定../groups/default
。
-
这个示例添加了一个 Avro 模式工件 ID,其工件 ID 为
验证响应是否包含预期的 JSON 正文,以确认是否已添加了自定义工件版本。例如:
{"createdBy":"","createdOn":"2021-04-16T10:51:43+0000","modifiedBy":"", "modifiedOn":"2021-04-16T10:51:43+0000","id":"my-share-price","version":"1.1.1", "type":"AVRO","globalId":3,"state":"ENABLED","groupId":"my-group","contentId":3}
-
添加工件时,指定了
1.1.1
的自定义版本。 -
这是添加到 registry 中的第三个构件,因此全局 ID 和内容 ID 的值为
3
。
-
添加工件时,指定了
使用其工件 ID 和 API 路径中的版本从 registry 检索工件内容。在本例中,指定的 ID 是
my-share-price
,版本是1.1.1
:$ curl -H "Authorization: Bearer $ACCESS_TOKEN" \ MY-REGISTRY-URL/apis/registry/v2/groups/my-group/artifacts/my-share-price/versions/1.1.1 {"type":"record","name":"price","namespace":"com.example", "fields":[{"name":"symbol","type":"string"},{"name":"price","type":"string"}]}
其他资源
- 如需更多 REST API 示例请求,请参阅 Apicurio Registry REST API 文档