4.3. 使用 Apicurio Registry REST API 命令管理 schema 和 API 工件引用

流程

1. 添加 ItemId 模式工件，您要使用 /groups/{groupId}/artifacts 操作创建嵌套工件引用：

   $ curl -X POST MY-REGISTRY-URL/apis/registry/v3/groups/my-group/artifacts \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer $ACCESS_TOKEN" \
      --data '{"artifactId":"ItemId","artifactType":"AVRO","firstVersion":{"version":"1.0.0","content":{"content":"{\"namespace\":\"com.example.common\",\"name\":\"ItemId\",\"type\":\"record\",\"fields\":[{\"name\":\"id\",\"type\":\"int\"}]}","contentType":"application/json"}}}'

   • 这个示例添加了一个 Avro schema 工件，工件 ID 为 ItemId。如果没有指定唯一的工件 ID，Apicurio Registry 会自动生成一个作为 UUID。
   • MY-REGISTRY-URL 是在其上部署 Apicurio Registry 的主机名。例如： my-cluster-service-registry-myproject.example.com。
   • 本例在 API 路径中指定 my-group 的组 ID。如果没有指定唯一的组 ID，则必须在 API 路径中指定 ../groups/default。

2. 验证响应是否包含预期的 JSON 正文，以确认是否添加了构件。例如：

   {"artifact":{"owner":"","createdOn":"2024-09-26T16:27:38Z","modifiedBy":"","modifiedOn":"2024-09-26T16:27:38Z","artifactType":"AVRO","groupId":"my-group","artifactId":"ItemId"},"version":{"version":"1.0.0","owner":"","createdOn":"2024-09-26T16:27:38Z","artifactType":"AVRO","globalId":2,"state":"ENABLED","groupId":"my-group","contentId":2,"artifactId":"ItemId"}}

3. 添加 Item 模式工件，它使用 /groups/{groupId}/artifacts 操作包含到 ItemId 模式的工件引用：

   $ curl -X POST MY-REGISTRY-URL/apis/registry/v3/groups/my-group/artifacts \
   -H 'Content-Type: application/json' \
   -H "Authorization: Bearer $ACCESS_TOKEN" \
   --data-raw '{
   	"artifactId": "Item",
   	"artifactType": "AVRO",
   	"firstVersion": {
   		"version": "1.0.0",
   		"content": {
   			"content": "{\"namespace\":\"com.example.common\",\"name\":\"Item\",\"type\":\"record\",\"fields\":[{\"name\":\"itemId\",\"type\":\"com.example.common.ItemId\"}]}",
   			"contentType": "application/json",
   			"references": [
   				{
   					"name": "com.example.common.ItemId",
   					"groupId": "my-group",
   					"artifactId": "ItemId",
   					"version": "1.0.0"
   				}
   			]
   		}
   	}
   }'

   • 对于工件引用，您必须指定 application/create.extended+json 的自定义内容类型，它将扩展 application/json 内容类型。

4. 验证响应是否包含预期的 JSON 正文，以确认工件是否已创建有引用。例如：

   {"artifact":{"owner":"","createdOn":"2024-09-26T16:28:45Z","modifiedBy":"","modifiedOn":"2024-09-26T16:28:45Z","artifactType":"AVRO","groupId":"my-group","artifactId":"Item"},"version":{"version":"1.0.0","owner":"","createdOn":"2024-09-26T16:28:45Z","artifactType":"AVRO","globalId":3,"state":"ENABLED","groupId":"my-group","contentId":3,"artifactId":"Item"}}

5. 通过指定包含引用的工件的协调，从 Apicurio Registry 检索工件引用：

   $ curl -H "Authorization: Bearer $ACCESS_TOKEN" MY-REGISTRY-URL/apis/registry/v3/groups/my-group/artifacts/Item/versions/1.0.0/references

6. 验证响应是否包含此工件引用的预期 JSON 正文。例如：

   [{"groupId":"my-group","artifactId":"ItemId","version":"1.0.0","name":"com.example.common.ItemId"}]

1. 检索 dereferenced (lined) schema 内容：

   $ curl -H "Authorization: Bearer $ACCESS_TOKEN" MY-REGISTRY-URL/apis/registry/v3/groups/my-group/artifacts/Item/versions/1.0.0/content?references=DEREFERENCE

2. 验证响应是否包含此工件内容的预期 JSON 正文，其中包含内联引用。例如：

   {"type":"record","name":"Item","namespace":"com.example.common","fields":[{"name":"itemId","type":{"type":"record","name":"ItemId","fields":[{"name":"id","type":"int"}]}}]}