第 3 章 使用 Web 控制台管理 Service Registry 内容
您可以使用 Service Registry web 控制台管理 Service Registry 中存储的模式和 API 工件。这包括上传和浏览 Service Registry 内容、为内容配置可选规则,以及生成客户端 sdk 代码:
- 第 3.1 节 “使用 Service Registry web 控制台查看工件”
- 第 3.2 节 “使用 Service Registry web 控制台添加工件”
- 第 3.3 节 “使用 Service Registry web 控制台配置内容规则”
- 第 3.4 节 “使用 Service Registry web 控制台为 OpenAPI 工件生成客户端 SDK”
- 第 3.5 节 “使用 Service Registry web 控制台更改工件所有者”
- 第 3.6 节 “使用 Web 控制台配置 Service Registry 实例设置”
- 第 3.7 节 “使用 Service Registry web 控制台导出和导入数据”
3.1. 使用 Service Registry web 控制台查看工件
您可以使用 Service Registry web 控制台浏览存储在 Service Registry 中的 schema 和 API 工件。本节演示了查看 Service Registry 工件、组、版本和工件规则的简单示例。
先决条件
- Service Registry 已在您的环境中安装并运行。
登录到 Service Registry web 控制台:
http://MY_REGISTRY_URL/ui
- 使用 Web 控制台、命令行、Maven 插件或 Java 客户端应用程序将工件添加到 Service Registry 中。
流程
在 Artifacts 选项卡中,浏览存储在 Service Registry 中的工件列表,或者输入搜索字符串来查找工件。您可以选择根据特定条件(如名称、组、标签或全局 ID)搜索。
图 3.1. Service Registry web 控制台中的工件
点工件查看以下详情:
- 概述 :显示工件版本元数据,如工件名称、工件 ID、全局 ID、内容 ID、标签、属性等。另外,还显示您可以为工件内容配置的有效性和兼容性规则。
- 文档 (仅限 OpenAPI 和 AsyncAPI):显示自动生成的 REST API 文档。
- 内容 :显示完整工件内容的只读视图。对于 JSON 内容,您可以点击 JSON 或 YAML 来显示您首选的格式。
- 参考 :显示此工件引用的所有工件的只读视图。您还可以单击 引用此工件的 View 工件。
- 如果添加了此工件的额外版本,您可以从页面标头中的 Version 列表中选择它们。
-
要将工件内容保存到本地文件,如
my-openapi.json
或my-protobuf-schema.proto
,然后点击页面末尾的 Download。