codebuddy支持三种自动生成ts类型定义的方法:一、解析openapi文档生成接口请求/响应类型;二、通过抓包流量分析生成鲁棒性类型;三、从前端ts接口反向生成openapi契约供后端使用。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如果您在进行前后端联调时需要自动生成请求与响应的类型定义,CodeBuddy 可基于接口契约或运行时流量反向推导出精确、可复用的 TypeScript 类型声明。以下是实现该目标的具体方法:
一、从 OpenAPI/Swagger 文档生成类型定义
该方法通过解析标准 API 描述文件中的 paths、schemas、requestBody 和 responses 字段,自动提取字段名、类型、必填性、嵌套结构及枚举值,生成符合 TypeScript 语法的 interface 或 type 声明。
1、将项目中已有的 openapi.yaml 或 swagger.json 文件上传至 CodeBuddy 的文档解析入口。
2、选择需导出类型的接口路径(如 GET /api/orders)并确认 HTTP 方法。
3、点击“导出 TypeScript 类型”按钮,系统将分别生成 OrdersGetRequest 与 OrdersGetResponse 两个类型声明。
4、复制生成结果,粘贴至项目中的 types/api/orders.ts 文件,并确保其被接口调用处正确导入。
二、通过抓包流量自动生成类型定义
该方法利用本地代理捕获真实请求与响应载荷,对 JSON 结构进行多轮采样分析,识别字段稳定性、空值容忍度与动态键名模式,从而生成兼顾鲁棒性与准确性的类型定义。
1、在 CodeBuddy 中启用 Network Sniffer 模式,并配置前端应用代理指向本地监听端口。
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 问题
2、在浏览器中触发目标接口调用(如提交表单或刷新订单列表),确保至少完成 3次不同参数组合 的请求。
3、点击“分析流量并生成类型”,系统将合并所有响应体,标记 always-present 字段为非可选,sometimes-null 字段添加 | null 联合类型。
4、查看预览后,选择“保存为 TS 接口”,指定输出目录为 src/types/generated/。
三、基于已有 TypeScript 接口反向生成请求/响应契约
该方法适用于后端尚未提供完整文档但前端已定义核心类型的情形,CodeBuddy 可将 interface 编译为 OpenAPI schema 片段,并进一步生成对应请求体校验规则与响应示例。
1、在 CodeBuddy 中打开包含响应模型的 TS 文件(如 src/types/user.ts),定位到 UserDetailResponse interface。
2、右键点击 interface 关键字,选择“生成 OpenAPI Schema”。
3、系统输出 YAML 格式的 schema 片段,包含 type、properties、required 及 example 字段。
4、将该片段插入项目中 openapi.yaml 的 components/schemas 区域,供后端 Swagger UI 渲染与校验使用。










