可使用 OpenAPI Generator CLI、Docker、CI/CD、云门户或 Rswag 五种方式,基于 OpenAPI 3.0 文件自动生成多语言 SDK 客户端代码。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如果您拥有一个符合 OpenAPI 3.0 规范的 YAML 或 JSON 文件,并希望据此自动生成多种编程语言的 SDK 客户端代码,则可借助标准化 CLI 工具链实现。以下是具体操作路径:
一、使用 OpenAPI Generator CLI 生成多语言客户端
OpenAPI Generator 是当前主流且持续维护的开源工具,支持 Java、Python、TypeScript、Go、C# 等 50 余种语言,其核心依赖是合法的 OpenAPI 文档(openapi.yaml 或 openapi.json)。
1、确保已安装 OpenAPI Generator CLI:通过 npm 全局安装 npm install -g @openapitools/openapi-generator-cli,或从 GitHub Releases 下载对应平台二进制文件并加入 PATH。
2、验证输入文档有效性:运行 openapi-generator validate -i openapi.yaml,确认无 missing required field 'openapi' 或 schema 解析错误。
3、生成 Java 客户端代码:执行 openapi-generator generate -i openapi.yaml -g java -o ./java-sdk,输出目录将包含 Maven 结构、模型类、API 接口及示例调用代码。
4、生成 TypeScript 客户端(基于 axios):运行 openapi-generator generate -i openapi.yaml -g typescript-axios -o ./ts-sdk,生成代码默认导出 ApiClient 类与各 endpoint 封装函数。
5、生成 Python 客户端:使用命令 openapi-generator generate -i openapi.yaml -g python -o ./py-sdk,生成包含 models、apis、configuration 模块的标准 Python 包,支持 pip install -e . 本地安装。
二、使用 Docker 容器方式免环境依赖生成
避免本地 Java 或 Node.js 环境配置冲突时,可直接调用官方 Docker 镜像启动生成流程,所有依赖隔离在容器内,确保行为一致。
1、拉取最新镜像:docker pull openapitools/openapi-generator-cli。
2、挂载当前目录并生成 Go 客户端:docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli generate -i /local/openapi.yaml -g go -o /local/go-sdk --additional-properties=packageName=client,withGoCodegenV2=true。
3、生成 C# 客户端并指定命名空间:docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli generate -i /local/openapi.yaml -g csharp -o /local/csharp-sdk --additional-properties=packageName=MyApiSdk,netCoreProjectFile=true。
4、生成 Rust 客户端(需 v7.0+ 支持):docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli generate -i /local/openapi.yaml -g rust -o /local/rust-sdk。
三、集成至 CI/CD 流水线自动触发生成
在 Git 仓库中将 openapi.yaml 提交后,可通过 GitHub Actions 或 GitLab CI 在每次推送时自动构建并推送 SDK 到私有包仓库,实现版本同步与交付自动化。
1、在 .github/workflows/sdk-gen.yml 中定义 job,监听 openapi.yaml 变更路径。
2、使用 actions/setup-java@v3 安装 JDK,再运行 curl -L https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/bin/utils/downloadJars.sh | bash 获取 JAR。
CodeBuddy Code CLI 的安装、配置与使用指南。CodeBuddy Code 是腾讯推出的 AI 驱动 CLI 编程助手,支持自然语言驱动开发。 - 必备触发词:CodeBuddy, codebuddy, AI CLI, Tencent AI coding, @tencent-ai/codebuddy-code, terminal AI assistant - 适用场景:安装 CodeBuddy CLI、配置 CodeBuddy、使用 CodeBuddy 命令、排查 CodeBuddy 问题
3、执行生成命令:java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -i openapi.yaml -g kotlin -o ./kotlin-sdk -c config/kotlin-config.json,其中 config/kotlin-config.json 可预设 packageName、groupId 等参数。
4、调用 ./gradlew publishToMavenLocal 或 mvn deploy 将生成的 SDK 发布至 Nexus 或 Artifactory。
四、通过 OpenAPI 门户在线生成轻量 SDK 示例
对于快速验证或临时调试,部分云厂商(如阿里云 OpenAPI 门户)提供网页端 SDK 示例生成功能,无需本地部署工具链,但仅输出代码片段而非完整工程。
1、访问目标云服务 OpenAPI 门户页面,例如阿里云 ECS 的 https://help.aliyun.com/document_detail/25548.html。
2、在搜索框输入接口名(如 DescribeRegions),进入该接口详情页。
3、在右侧“SDK 示例”区域,选择语言(Java/Python/Go)和 SDK 版本(V2/V3)。
4、点击“复制代码”获取已预填充参数、鉴权与异常处理逻辑的可运行示例片段。
5、粘贴至本地 IDE 后,按提示添加对应 SDK 依赖(如 aliyun-java-sdk-ecs)即可直接执行。
五、使用 Rswag 自动从 Rails 应用提取并生成客户端
Rswag 是面向 Ruby on Rails 的 OpenAPI 工具链,它能反向从控制器代码和路由中推导出 OpenAPI 规范,再调用 OpenAPI Generator 生成客户端,适用于已有 Rails 后端项目。
1、在 Gemfile 中添加 gem 'rswag-api' 与 gem 'rswag-specs',执行 bundle install。
2、运行 rails generate rswag:specs:install 初始化 spec/swagger_helper.rb 和相关配置。
3、在测试中编写 Swagger 文档描述,例如在 spec/requests/v1/pets_spec.rb 中声明 path '/pets' 及 response 200。
4、执行 rake rswag:specs:generate,生成 openapi.json 至 swagger_docs 目录。
5、调用 CLI 命令:openapi-generator generate -i swagger_docs/v1/swagger.json -g python -o ./rails-python-client,完成客户端构建。

















