SuperAPI AI 工具集

config

编程与开发

查看项目

更新于 10-15 23:47

技能介绍

用途:该技能指导智能体编写 kubb.config.ts,并为从 OpenAPI/Swagger 规范生成 TypeScript 代码选择合适的 @kubb/plugin-* 包。生成通过 kubb CLI(kubb generate)执行,同一构建也支撑内置的 MCP 服务器。适用场景包括在项目中设置 Kubb、添加或替换生成器插件、排查生成输出缺失或错误的原因。

主要能力:展示 kubb.config.ts 的结构;列出生成器插件及组合方式;指向各插件的 Options 类型与 kubb.dev 文档页作为权威选项来源;描述 validate、init、generate 工作流。

配置要点:使用 defineConfig 定义 root、input(本地路径或远程 URL)、output(path、clean、barrel)和 plugins 数组。pluginTs 是基础插件。每个已安装插件的 node_modules/@kubb/plugin-<name>/kubb-extension.json 说明其依赖:需添加 dependencies 中的每个名称;role 为 consumer 的插件(框架插件和 pluginMcp)还需 role 为 client 的插件(pluginAxios 或 pluginFetch);optionalDependencies 中的名称仅在部分选项值下需要。每个生成器插件有自己的 output.path,相对于顶层 output.path 解析,建议按生成类型分文件夹。仅在需要时通过顶层 adapter: adapterOas({...}) 设置适配器选项。

可用插件:pluginTs(TypeScript 类型,推荐基础)、pluginAxios、pluginFetch、pluginReactQuery、pluginVueQuery、pluginSwr、pluginZod、pluginFaker、pluginMsw、pluginCypress、pluginMcp、pluginRedoc。常见组合:仅类型用 pluginTs();类型化数据获取加 pluginAxios() 或 pluginFetch(),hooks 再加框架插件;运行时校验加 pluginZod();测试与 mock 加 pluginFaker() 和 pluginMsw()。

工作流:先用 kubb validate <spec> 校验规范;用 kubb init 脚手架并安装(可传 --input、--output、--plugins 跳过提示,或手写配置);用 kubb generate 生成(--verbose 诊断,--watch 监听变更);最后对生成输出做类型检查并接入应用。

限制:output.clean 为 true 时生成是破坏性的,切勿将 output.path 指向手写源码;生成前应校验不可信规范;output.format 或 output.lint 设为 'auto' 可用项目已有工具格式化与 lint。插件精确选项请以已安装包的 Options 类型和官方文档页为准,不要猜测选项名。