3.2. 使用 Apicurio Registry web 控制台添加工件
您可以使用 Apicurio Registry web 控制台将 schema 和 API 工件上传到 Apicurio Registry。本节演示了创建 Apicurio Registry 工件和添加新工件版本的简单示例。
先决条件
- Apicurio Registry 在您的环境中安装并运行。
已登陆到 Apicurio Registry web 控制台:
http://MY_REGISTRY_UI_URL/
流程
在 Explore 选项卡中,点 Create artifact,然后完成 Create artifact 向导:
注意您可以创建一个没有内容的占位符工件,但您必须指定工件类型,因为 Apicurio Registry 无法自动检测内容类型。通过创建占位符,您可以先创建规则并在稍后添加内容。
指定 Artifact Coordinates 并点 Next :
-
组 ID 和 Artifact ID :使用默认空设置自动生成工件 ID,并将工件
添加到默认工件组中。另外,您可以输入可选的工件组或工件 ID。 - 类型 :使用默认 Auto-Detect 设置来自动检测工件类型(如果创建空工件时不允许),或者从列表中选择工件类型,如 Avro Schema 或 OpenAPI。您必须手动选择 Kafka Connect Schema 工件类型,该工件类型无法自动检测到。
-
组 ID 和 Artifact ID :使用默认空设置自动生成工件 ID,并将工件
指定 Artifact Metadata 并点 Next :
- Name :输入新工件的可选友好名称。
- 描述 :输入新工件的可选描述。
- 标签 :(可选)为新工件添加一个或多个标签(名称/值对)。
指定 Version 内容 并点 Next :
- 版本号 :创建第一个版本时可选添加版本字符串。
Content: 使用以下选项之一指定内容:
-
从文件 中:单击 Browse,然后选择一个文件,或者拖放文件。例如,
my-openapi.json或my-schema.proto。或者,您可以在文本框中输入文件内容。 -
从 URL :输入有效且可访问的 URL,然后单击 Fetch。例如:
https://petstore3.swagger.io/api/v3/openapi.json。
-
从文件 中:单击 Browse,然后选择一个文件,或者拖放文件。例如,
指定 版本元数据 :
- Name :输入第一个工件版本的可选友好名称。
- 描述 :输入第一个工件版本的可选描述。
- 标签 :(可选)为第一个工件版本添加一个或多个标签(名称/值对)。
点 Create 并查看工件详情:
- 概述 :显示工件元数据,如工件 ID、名称、描述、标签等。另外,还显示您可以为工件内容配置的有效性和兼容性规则。
- 版本 :显示所有工件版本的列表。这将为空,除非您在创建工件时上传第一个版本。
分支 :显示工件的分支列表。这将至少显示最新的
分支,但可能会根据您的配置显示其他生成的分支。以下示例显示了 Apache Avro 工件示例:
图 3.4. Apicurio Registry web 控制台中的工件详情
在 Overview 选项卡中,点 Edit pencil 图标来编辑工件元数据,如名称或描述。
您还可以为分类和搜索目的添加零个或多个标签(名称 + 值)。要添加标签,请执行以下步骤:
- 点 Add label。
- 输入键名称和值(可选)。
- 重复前两个步骤来添加多个属性。
- 点击 Save。
-
要将工件内容保存到本地文件,如
my-protobuf-schema.proto或my-openapi.json,请点击页面末尾的 Download。 要添加新的工件版本,请切换到 Versions 选项卡,然后在工具栏中点 Create version。从那里提供以下信息:
- 版本号 :(可选):为新版本添加版本字符串。
Content: 使用以下选项之一指定内容:
-
从文件 中:单击 Browse,然后选择一个文件,或者拖放文件。例如,
my-openapi.json或my-schema.proto。或者,您可以在文本框中输入文件内容。 -
从 URL :输入有效且可访问的 URL,然后单击 Fetch。例如:
https://petstore3.swagger.io/api/v3/openapi.json。
-
从文件 中:单击 Browse,然后选择一个文件,或者拖放文件。例如,
- 现在,您可以点 Create 按钮创建新版本。
要删除工件,请在页面标头中点 Delete。
警告删除工件会删除工件及其所有版本,且无法撤销。