3.4. 使用 Apicurio Registry web 控制台为 OpenAPI 工件生成 client SDK


您可以使用 Apicurio Registry web 控制台为 OpenAPI 工件配置、生成和下载客户端软件开发套件(SDK)。然后,您可以使用生成的客户端 SDK 来根据 OpenAPI 为特定平台构建您的客户端应用程序。

Apicurio Registry 为以下编程语言生成客户端 SDK:

  • C#
  • Go
  • Java
  • PHP
  • Python
  • Ruby
  • Swift
  • TypeScript
注意

OpenAPI 工件的客户端 SDK 仅在您的浏览器中运行,无法使用 API 自动运行。每次在 Apicurio Registry 中添加新工件版本时,您必须重新生成客户端 SDK。

先决条件

  • Apicurio Registry 在您的环境中安装并运行。
  • 已登陆到 Apicurio Registry web 控制台:

    http://MY_REGISTRY_URL/ui

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

流程

  1. Artifacts 选项卡中,浏览存储在 Apicurio Registry 中的工件列表,或者输入搜索字符串来查找特定的 OpenAPI 工件。您可以从列表中选择按条件进行搜索,如名称、组、标签或全局 ID。
  2. 点列表中的 OpenAPI 工件来查看其详情。
  3. Version metadata 部分,点 Generate client SDK,并在对话框中配置以下设置:

    • 语言 :选择用于生成客户端 SDK 的编程语言,例如 Java
    • 生成的客户端类名称 :输入客户端 SDK 的类名称,如 MyJavaClientSDK。
    • 生成的客户端软件包名称 :输入客户端 SDK 的软件包名称,例如 io.my.example.sdk
  4. 点击 Show advanced settings 配置可选的以逗号分隔的路径模式列表,以包括或排除:

    • 包括路径模式 :输入生成客户端 SDK 时包括的特定路径,例如: **/ configured , **/my-path86]。如果此字段为空,则会包括所有路径。
    • 排除路径模式 :在生成客户端 SDK 时输入要排除的特定路径,例如: **/my-other-path86]。如果此字段为空,则不会排除任何路径。

      图 3.4. 在 Apicurio Registry web 控制台中生成 Java 客户端 SDK

  5. 当您在对话框中配置了设置后,点 Generate 并下载
  6. 在对话框中输入客户端 SDK 的文件名,如 my-client-java.zip,然后单击 Save 以下载。
返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

Theme

© 2025 Red Hat