Agent Skills
返回列表
💻

Swagger Codegen API 客户端构建器

开发编程 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/swagger-codegen-api-client-builder。

技能介绍

解决的问题

维护多语言 API 客户端时,手写代码重复且容易与 OpenAPI 规范脱节。规范变更后,开发者需要手动更新请求方法、类型定义和错误处理,容易遗漏字段或引入不一致。

工作原理

该技能基于 swagger-codegen 与 openapi-generator-cli,读取 OpenAPI 3.x 规范,直接生成带类型的客户端库。支持三种目标栈:

  • TypeScript-axios:生成基于 Axios 的客户端,附带请求与响应类型。
  • Python-requests:生成使用 Requests 库的同步客户端。
  • Go-http:生成标准库 net/http 驱动的客户端。

通过自定义 mustache 模板,可以控制生成代码的风格、模块结构以及附加逻辑。

适用边界

  • 仅支持 OpenAPI 3.x 规范,OpenAPI 2.0 不在范围内。
  • 生成结果取决于模板与上游工具版本,复杂 API 可能需要二次调整。
  • 上游 SwaggerUI 会通过 Scarf 收集匿名安装分析数据,不涉及代码内容。

使用场景

  • 后端团队维护 OpenAPI 3.x 接口文档,需要用 TypeScript-axios 生成带类型的客户端,避免手工改请求与响应类型。
  • Python 服务调用内部 OpenAPI 接口,希望生成 requests 客户端,减少重复写鉴权与重试逻辑。
  • Go 微服务要对接多个 OpenAPI 3.x 后端,需生成 net/http 客户端并统一错误处理。
  • 已有 OpenAPI 规范,想通过自定义 mustache 模板调整生成代码风格和模块拆分。

适合人员

  • 后端工程师维护 OpenAPI 3.x 规范,需要按规范生成多语言客户端,减少手写重复代码。
  • 前端工程师调用 TypeScript-axios API,希望获得完整请求与响应类型,避免字段遗漏。
  • Python 服务开发者需要从 OpenAPI 规范生成 requests 客户端,统一鉴权与重试。
  • Go 微服务开发者需要生成 net/http 客户端,并按团队模板控制代码风格。