搜索

第 3 章 使用 Web 控制台管理 Apicurio Registry 内容

download PDF

您可以使用 Apicurio Registry web 控制台管理 Apicurio Registry 中存储的模式和 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_URL/ui

  • 使用 Web 控制台、命令行、Maven 插件或 Java 客户端应用程序将工件添加到 Apicurio Registry 中。

流程

  1. Artifacts 选项卡中,浏览 Apicurio Registry 中存储的工件列表,或者输入搜索字符串以查找工件。您可以从列表中选择按特定条件搜索,如名称、组、标签或全局 ID。

    图 3.1. Apicurio Registry web 控制台中的工件

    Registry web 控制台中的工件
  2. 点工件查看以下详情:

    • 概述 :显示工件版本元数据,如工件名称、工件 ID、全局 ID、内容 ID、标签、属性等。另外,也显示可针对工件内容配置的有效性和兼容性的规则。
    • 文档 (仅限 OpenAPI 和 AsyncAPI):显示自动生成的 REST API 文档。
    • 内容 :显示完整工件内容的只读视图。对于 JSON 内容,您可以点 JSONYAML 来显示您首选的格式。
    • 参考 :显示此工件引用的所有工件的只读视图。您还可以单击 引用此工件的 View 工件
  3. 如果添加了此工件的额外版本,您可以从页面标头中的 Version 列表中选择它们。
  4. 要将工件内容保存到本地文件,如 my-openapi.jsonmy-protobuf-schema.proto,然后点击页面末尾的 Download
Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.