CodeBuddy支持五种API生成方式：一、CLI命令行自动生成Spring Boot CRUD接口；二、IDE中NL2Code面板实时生成Controller与DTO；三、Figma设计稿反向生成OpenAPI契约；四、调用API批量生成订单模块代码；五、自定义模板固化团队规范。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
如果您需要为新功能快速实现符合项目规范的API接口，但手动编写重复性CRUD逻辑耗时且易错，则CodeBuddy可通过自然语言指令直接生成结构完整、带校验与错误处理的可运行代码。以下是多种可行的操作路径：
一、使用CodeBuddy CLI命令行工具生成接口
该方式适用于已初始化项目本地环境、需快速产出后端模块的场景，CLI能自动识别技术栈并注入依赖。
1、在终端中确保已安装CodeBuddy CLI并完成登录：codebuddy login，按提示绑定腾讯云账号。
2、进入项目根目录，执行自然语言指令：codebuddy generate "Spring Boot用户注册接口：接收name、email、password，校验邮箱格式与密码长度，加密存储，返回成功状态及用户ID"。
3、CLI自动创建Controller、Service、DTO及对应单元测试文件，并将BCrypt与Lombok依赖写入pom.xml（若检测到Maven）。
4、检查生成代码中的@Valid注解与@Email约束是否生效，确认响应体结构符合RESTful规范。
二、在IDE中通过NL2Code面板触发生成
该方式适合未脱离编码界面的高频小规模接口开发，支持上下文感知与实时预览。
1、在VS Code或JetBrains IDE中打开项目，唤出右侧AI Copilot面板。
2、输入结构化指令：[Java][Spring Boot] 实现GET /api/v1/products/{id}，根据ID查商品详情，返回ProductResponse对象，404时抛出ResourceNotFoundException。
3、点击“生成”按钮，等待数秒，面板输出完整Controller方法、自定义异常类及Response DTO定义。
4、将生成代码粘贴至对应包路径下，IDE自动识别并提示缺失import，补全@PathVariable与@ResponseStatus(HttpStatus.NOT_FOUND)等关键注解。
三、基于Figma设计稿反向生成API契约
该方式适用于前后端并行开发场景，先有UI原型再同步产出接口定义，保障契约一致性。
1、在Figma中为商品列表页添加交互标注，注明“点击‘加入购物车’调用POST /api/cart/items，传入productId和quantity”。
2、右键画板选择Sync to CodeBuddy，IDE自动解析交互语义。
3、CodeBuddy在/server/routes/目录下生成cart.routes.ts（Node.js）或CartController.java（Spring Boot），含路径、方法、请求体Schema注释。
4、检查生成文件中是否包含OpenAPI 3.0格式的@ApiParam与@ApiResponse注解，确认Swagger文档可自动渲染。
四、调用CodeBuddy API服务批量生成接口集合
该方式适用于中大型项目需一次性落地多个关联接口，如整套订单管理模块。
1、准备JSON配置文件order-api-spec.json，明确列出接口路径、方法、参数、状态码及示例响应。
2、执行curl命令调用CodeBuddy开放API：curl -X POST https://api.codebuddy.tech/v1/generate -H "Authorization: Bearer YOUR_TOKEN" -d @order-api-spec.json。
3、接收返回的ZIP包，解压后获得按MVC分层组织的完整代码树，含Swagger YAML、Postman Collection及Jest测试桩。
4、验证生成代码中是否统一使用@RequestBody而非Query参数传递复杂对象，确保与前端Axios调用方式匹配。
五、使用自定义指令模板固化团队接口规范
该方式适用于已有成熟工程规范的团队，避免每次重复描述相同约束条件。
1、在项目根目录创建.codebuddy/commands/api-standard.yaml，定义标准响应结构、日志埋点、鉴权拦截等模板片段。
2、在IDE中输入快捷指令：/api-standard POST /user/profile 更新用户头像，接收base64字符串，限制1MB，上传至COS并返回访问URL。
3、CodeBuddy自动套用模板，注入@PreAuthorize("hasRole('USER')")、COS客户端Bean注入、文件大小校验切面等团队约定逻辑。
4、检查生成代码中是否包含标准的Result<String>泛型包装，确认错误码映射表与全局异常处理器兼容。
