第 3 章 使用 Web 控制台管理 Apicurio Registry 内容
本章介绍了如何使用 Apicurio Registry Web 控制台管理存储在 registry 中的 schema 和 API 工件。这包括上传和浏览 registry 内容,以及配置可选规则:
3.1. 使用 Apicurio Registry Web 控制台添加工件 复制链接链接已复制到粘贴板!
您可以使用 Apicurio Registry Web 控制台将事件 schema 和 API 设计工件上传到 registry。有关您可以上传的工件类型的详情,请参阅 第 9 章 Apicurio Registry artifact 引用。本节演示了上传 Apicurio Registry 工件、应用工件规则和添加新的工件版本的简单示例。
前提条件
- 必须在自己的环境中安装并运行 Apicurio Registry。
流程
连接到 Apicurio Registry web 控制台:
http://MY_REGISTRY_URL/ui点 Upload artifact,并指定以下内容:
-
group 和 ID :使用默认空设置自动生成 ID 和
默认组,或者输入可选的工件组或 ID。 类型 :使用默认 Auto-Detect 设置来自动检测工件类型,或者从下拉菜单中选择工件类型,例如 Avro Schema 或 OpenAPI。
注意Apicurio Registry 服务器无法自动检测 Kafka Connect Schema 工件类型。您必须手动选择此工件类型。
-
工件: Drag 和 drop or click Browse 以上传文件,如
my-schema.json或my-openapi.json。
-
group 和 ID :使用默认空设置自动生成 ID 和
点 Upload,查看 Artifact Details :
图 3.1. Apicurio Registry Web 控制台中的工件详情
- info :显示工件名称和可选的组、描述、生命周期状态、创建和最后一次修改。点击 Edit Artifact Metadata 铅笔图标编辑工件名称和描述或添加标签,然后点 Download 向本地下载工件文件。另外,还显示您可以启用和配置的构件 内容规则。
- 文档 (仅限OpenAPI):显示自动生成的 REST API 文档。
- 内容 :显示完整工件内容的只读视图。
- 在 内容 规则中,单击 Enable 来配置 Validity Rule 或 Compatibility Rule,然后从下拉菜单中选择相应的规则配置。如需了解更多详细信息,请参阅 第 9 章 Apicurio Registry artifact 引用。
-
点 Upload new version 添加新工件版本,然后拖放或点击 Browse 上传该文件,如
my-schema.json或my-openapi.json。 要删除工件,点 Upload new version 旁边的垃圾桶图标。
警告删除工件会删除工件及其所有版本,无法撤消。工件版本是不可变的,不能单独删除。