3.2. 使用 Service Registry web 控制台添加工件
您可以使用 Service Registry web 控制台将事件 schema 和 API 工件上传到 Service Registry。本节演示了上传 Service Registry 工件和添加新工件版本的简单示例。
先决条件
- Service Registry 已在您的环境中安装并运行。
登录到 Service Registry web 控制台:
http://MY_REGISTRY_URL/ui
流程
在 Artifacts 选项卡中,点 Upload artifact,并指定以下详情:
-
组和 ID :使用默认空设置自动生成工件 ID,并将工件
添加到默认
工件组中。或者,您可以输入可选的工件组名称或 ID。 - 类型 :使用默认的 Auto-Detect 设置来自动检测工件类型,或者从列表中选择工件类型,如 Avro Schema 或 OpenAPI。您必须手动选择 Kafka Connect Schema 工件类型,该类型无法被自动探测。
工件 :使用以下选项之一指定工件位置:
-
从文件 :点 Browse,然后选择一个文件,或者拖放文件。例如,
my-openapi.json
或my-schema.proto
。或者,您也可以在文本框中输入文件内容。 -
从 URL: 输入有效并可访问 URL,然后单击 Fetch。例如:
https://petstore3.swagger.io/api/v3/openapi.json
。
-
从文件 :点 Browse,然后选择一个文件,或者拖放文件。例如,
-
组和 ID :使用默认空设置自动生成工件 ID,并将工件
点 Upload 并查看工件详情:
- 概述 :显示工件版本元数据,如工件名称、工件 ID、全局 ID、内容 ID、标签、属性等。另外,还显示您可以为工件内容配置的有效性和兼容性规则。
- 文档 (仅限 OpenAPI 和 AsyncAPI):显示自动生成的 REST API 文档。
内容 :显示完整工件内容的只读视图。对于 JSON 内容,您可以点击 JSON 或 YAML 来显示您首选的格式。
以下示例显示了 Protobuf 模式工件示例:
图 3.2. Service Registry web 控制台中的工件详情
在 Overview 选项卡中,点 Edit Mapping 图标编辑工件元数据,如名称或描述。
您还可以输入一个可选的以逗号分隔的标签列表来搜索,或者添加与工件关联的任意属性的键值对。要添加属性,请执行以下步骤:
- 点 Add property。
- 输入键名称和值。
- 重复前两个步骤来添加多个属性。
- 点击 Save。
-
要将工件内容保存到本地文件,如
my-protobuf-schema.proto
,请单击页面末尾的 Download。 -
要添加新工件版本,请单击页面标头中的 Upload new version,然后拖放或点击 Browse 上传文件,如
my-avro-schema.json
或my-openapi.json
。 要删除工件,请单击页面标头中的 Delete。
警告删除工件会删除工件及其所有版本,且无法撤消。