第 3 章 使用 Web 控制台管理 Apicurio Registry 内容
您可以使用 Apicurio Registry web 控制台管理 Apicurio Registry 中存储的 schema 和 API 工件。这包括上传和浏览 Apicurio Registry 内容,为内容配置可选规则并生成客户端 sdk 代码:
3.1. 使用 Apicurio Registry web 控制台查看工件 复制链接链接已复制到粘贴板!
您可以使用 Apicurio Registry web 控制台浏览存储在 Apicurio Registry 中的 schema 和 API 工件。本节展示了查看 Apicurio Registry 组、工件、版本和规则的简单示例。
先决条件
- Apicurio Registry 在您的环境中安装并运行。
已登陆到 Apicurio Registry web 控制台:
http://MY_REGISTRY_UI_URL/- 使用 Web 控制台、命令行、Maven 插件或客户端应用程序将工件添加到 Apicurio Registry 中。
流程
在 Explore 选项卡中,浏览存储在 Apicurio Registry 中的工件列表,或者输入搜索字符串来查找工件。您可以从列表中选择按特定条件进行搜索,如名称、组、标签或全局 ID。
图 3.1. Apicurio Registry web 控制台中的工件
点工件查看以下详情:
- 概述 :显示工件元数据,如工件 ID、名称、描述、标签等。另外,还显示您可以为工件内容配置的有效性和兼容性规则。
- 版本 :显示所有工件版本的列表。这将为空,除非您在创建工件时上传第一个版本。
分支 :显示工件的分支列表。这将至少显示最新的
分支,但可能会根据您的配置显示其他生成的分支。图 3.2. Apicurio Registry web 控制台中的工件详情
点 Versions 选项卡查看所有工件版本的列表。然后,单击列表中的某个版本,或者从列表中某个版本的 Action 菜单中选择 View Version。然后,您会看到以下工件版本详情:
- 概述 :显示工件版本元数据,如版本名称、描述、全局 ID、内容 ID、标签等。另外,还显示为工件版本创建的任何注释。
- 文档 (仅限 OpenAPI 和 AsyncAPI):显示自动生成的 REST API 文档。
- 内容 :显示完整工件版本内容的只读视图。对于 JSON 内容,您可以点 JSON 或 YAML 来显示您首选的格式。
引用 :显示此工件版本引用的所有工件的只读视图。您还可以点引用此 工件版本的 View 工件。
图 3.3. Apicurio Registry web 控制台中的工件版本详情
-
要将工件内容保存到本地文件,如
my-openapi.json或my-protobuf-schema.proto,然后点 Download。