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

流程

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

   $ curl -X POST MY-REGISTRY-URL/apis/registry/v2/groups/my-group/artifacts \
      -H "Content-Type: application/json; artifactType=AVRO" \
      -H "X-Registry-ArtifactId: ItemId" \
      -H "Authorization: Bearer $ACCESS_TOKEN" \
      --data '{"namespace": "com.example.common", "type": "record", "name": "ItemId", "fields":[{"name":"id", "type":"int"}]}'

   Copy to Clipboard Toggle word wrap
   • 这个示例添加了一个 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 正文，以确认添加了构件。例如：

   {"name":"ItemId","createdBy":"","createdOn":"2022-04-14T10:50:09+0000","modifiedBy":"","modifiedOn":"2022-04-14T10:50:09+0000","id":"ItemId","version":"1","type":"AVRO","globalId":1,"state":"ENABLED","groupId":"my-group","contentId":1,"references":[]}

   Copy to Clipboard Toggle word wrap

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

   $ curl -X POST MY-REGISTRY-URL/apis/registry/v2/groups/my-group/artifacts \
   -H 'Content-Type: application/create.extended+json' \
   -H "X-Registry-ArtifactId: Item" \
   -H 'X-Registry-ArtifactType: AVRO' \
   -H "Authorization: Bearer $ACCESS_TOKEN" \
   --data-raw '{
       "content": "{\r\n \"namespace\":\"com.example.common\",\r\n  \"name\":\"Item\",\r\n  \"type\":\"record\",\r\n  \"fields\":[\r\n   {\r\n  \"name\":\"itemId\",\r\n   \"type\":\"com.example.common.ItemId\"\r\n        }\r\n    ]\r\n}",
       "references": [
           {
               "groupId": "my-group",
               "artifactId": "ItemId",
               "name": "com.example.common.ItemId",
               "version": "1"
           }
       ]
   }'

   Copy to Clipboard Toggle word wrap
   • 对于工件引用，您必须指定自定义内容类型 application/create.extended+json，这会扩展 application/json 内容类型。

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

   {"name":"Item","createdBy":"","createdOn":"2022-04-14T11:52:15+0000","modifiedBy":"","modifiedOn":"2022-04-14T11:52:15+0000","id":"Item","version":"1","type":"AVRO","globalId":2,"state":"ENABLED","groupId":"my-group","contentId":2, "references":[{"artifactId":"ItemId","groupId":"my-group","name":"ItemId","version":"1"}] }

   Copy to Clipboard Toggle word wrap

5. 通过指定包含引用的工件的全局 ID，从 Apicurio Registry 检索工件引用。在本例中，指定的全局 ID 是 2：

   $ curl -H "Authorization: Bearer $ACCESS_TOKEN" MY-REGISTRY-URL/apis/registry/v2/ids/globalIds/2/references

   Copy to Clipboard Toggle word wrap

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

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

   Copy to Clipboard Toggle word wrap