kubb

基于OpenAPI规范,自动生成TypeScript/React等全栈代码的CLI工具。

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:kubb。
它的用途是:基于OpenAPI规范,自动生成TypeScript/React等全栈代码的CLI工具。
完整的 Skill 内容见:https://321skill.com/skills/kubb/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

“帮我在项目中配置Kubb,根据`openapi.json`文件生成TypeScript类型定义和React Query hooks。”,它会引导你创建配置文件并运行命令,自动生成与API完全类型匹配的客户端代码,省去手动定义类型的麻烦。

介绍

Kubb是一个代码生成工具,它通过解析OpenAPI/Swagger规范,自动生成TypeScript类型、React Query hooks、Zod验证器、Axios客户端等代码,解决前后端接口定义与客户端代码手动同步的繁琐和易错问题。

使用时,你只需提供一个OpenAPI规范文件(YAML或JSON格式),通过配置文件(kubb.config.ts)指定输出目标(如生成TypeScript类型到./src/types,生成React Query hooks到./src/hooks),然后运行CLI命令即可自动生成对应的代码文件。

它非常适合需要与REST API交互的前端、后端和全栈开发者,尤其是在团队协作中,能确保类型安全并大幅减少手写样板代码的时间。

建议在项目初期或引入新API时集成Kubb,并将其作为CI/CD流程的一部分,以确保生成的代码与API文档始终保持同步。注意,它主要面向基于OpenAPI规范的API,对于非标准或GraphQL API需要额外处理。

核心特点

核心区别在于其插件化架构,允许开发者通过组合不同插件(如TypeScript、React Query、Zod、Faker.js等)来高度定制生成的代码类型和结构,而非提供单一的固定输出。同时,它支持通过模板引擎(如Handlebars)对生成的代码进行深度自定义,灵活性远超同类工具。

注意事项

不适合非RESTful API或没有明确定义OpenAPI/Swagger规范的API项目。

常见问题

Kubb能生成哪些语言的代码?

主要生成TypeScript代码,通过插件可生成React组件、Zod模式、Faker.js模拟数据等,也支持生成Swift、Java等语言的客户端代码(通过社区插件)。

Kubb和OpenAPI Generator有什么区别?

Kubb更轻量、插件化,与TypeScript/React现代前端栈集成更深,配置更灵活;OpenAPI Generator支持的语言和框架更全面,但定制相对复杂。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/kubb/raw/index.md 读取 kubb 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。