3.4. 使用 Service Registry web 控制台为 OpenAPI 工件生成客户端 SDK
您可以使用 Service Registry web 控制台为 OpenAPI 工件配置、生成和下载客户端软件开发套件(SDK)。然后,您可以使用生成的客户端 SDK 根据 OpenAPI 为特定平台构建客户端应用程序。
Service Registry 为以下编程语言生成客户端 SDK:
- C#
- Go
- Java
- PHP
- Python
- Ruby
- Swift
- TypeScript
OpenAPI 工件的客户端 SDK 仅在浏览器中运行,无法使用 API 自动运行。每次在 Service Registry 中添加新工件版本时,您必须重新生成客户端 SDK。
先决条件
- Service Registry 已在您的环境中安装并运行。
登录到 Service Registry web 控制台:
http://MY_REGISTRY_URL/ui
- 使用 Web 控制台、命令行、Maven 插件或 Java 客户端应用程序将 OpenAPI 工件添加到 Service Registry 中。
流程
- 在 Artifacts 选项卡中,浏览存储在 Service Registry 中的工件列表,或者输入搜索字符串来查找特定的 OpenAPI 工件。您可以从列表中选择按条件(如名称、组、标签或全局 ID)搜索。
- 点列表中的 OpenAPI 工件来查看其详情。
在 Version metadata 部分中,点 Generate client SDK,并在对话框中配置以下设置:
- 语言 :选择生成客户端 SDK 的编程语言,例如 Java。
-
生成的客户端类名称 :输入客户端 SDK 的类名称,如
MyJavaClientSDK。
-
生成的客户端软件包名称 :输入客户端 SDK 的软件包名称,例如
io.my.example.sdk
点 Show advanced settings 配置可选的以逗号分隔的路径模式列表来包含或排除:
-
包括路径模式 :输入生成客户端 SDK 时要包括的具体路径,例如:
**/ netobserv, **/my-path8:0:1::
。如果此字段为空,则会包括所有路径。 排除路径模式 :在生成客户端 SDK 时输入要排除的具体路径,例如: beyond
/my-other-pathAttr
。如果此字段为空,则不会排除任何路径。图 3.4. 在 Service Registry web 控制台中生成 Java 客户端 SDK
-
包括路径模式 :输入生成客户端 SDK 时要包括的具体路径,例如:
- 当您在对话框中配置了设置后,点 Generate and download。
-
在对话框中输入 client SDK 的文件名,如
my-client-java.zip
,然后单击 Save 以下载。
其他资源
- Service Registry 使用 Microsoft 中的 Kiota 来生成客户端 SDK。如需更多信息,请参阅 GitHub 中的 Kiota 项目。
- 有关如何开始使用生成的 SDK 来构建客户端应用程序的示例,请参阅 Kiota API 客户端快速启动。