CodeBuddy API接口生成指南

CodeBuddy 生成 API 接口的过程，并非简单的“点击即生成”。关键在于清晰地表达意图、指明路径并配齐上下文——明确告知所需资源、HTTP 动作以及返回结构，它便能按照规范生成可运行代码，而非泛泛地完成“做个接口”。

用自然语言指令直接生成（最常用）

从零开始构建模块？一句描述即可触发完整的全栈代码生成，非常高效。

• 在终端进入项目根目录，确保已登录：codebuddy login
• 输入清晰描述，包含资源名、HTTP 方法、字段约束和框架要求。例如：
  生成 Spring Boot 用户管理接口：路径 /api/v1/users，支持 GET（查全部）、GET /{id}（查单个）、POST（创建）、PUT /{id}（更新）、DELETE /{id}（删除）；User 含 id、username（非空）、email（格式校验）、createdAt（只读）；响应统一包装为 Result
• 确认方案后，CodeBuddy 自动创建 Controller、Service、DTO、Repository 及配套单元测试，若检测到 Maven 还会自动更新 pom.xml。
• 检查生成的 @Valid、@Email、@PathVariable 等注解是否到位，确认状态码（201 创建、204 删除等）符合 RESTful 语义——这些细节都由系统自动处理。

基于数据库 Schema 反向生成（省时省力）

已有表结构？无需重写逻辑，Schema 本身就是最清晰的说明。

• 将 schema.sql 或 users.json 放入项目根目录或 /db/ 下。
• 执行命令：codebuddy generate api --schema users.sql --framework springboot
• 系统自动识别主键、NOT NULL、UNIQUE、外键关系，并生成带字段校验（如邮箱格式、手机号正则）、状态码分级（400 参数错误、404 不存在）以及异常拦截的完整 CRUD 路由。
• 密码、token 等敏感字段默认不返回，更新操作自动跳过 password 字段，无需额外声明。

在 IDE 里边写边补全（高频小迭代）

正在编辑 Java 或 Python 文件？光标定位后，AI 能准确感知所需补全内容。

• 打开 VS Code 或 JetBrains IDE，启用 CodeBuddy 插件。
• 新建 UserController.java，写上 @RestController 和 @RequestMapping("/users")。
• 在类内输入 get by id，AI 立即推荐 @GetMapping("/{id}") public ResponseEntity findById(@PathVariable Long id)。
• 光标停在方法体内，按 Ctrl+Enter 唤出面板，选择“生成 Service 调用 + 异常处理”，系统会自动注入 userService.findById(id) 并包裹 Optional.orElseThrow()。
• 生成后 IDE 自动补全 import，关键注解如 @ResponseStatus(HttpStatus.NOT_FOUND) 也一并附加，简化工作流程。

用 CODEBUDDY.md 固化团队规范（一劳永逸）

不想每次重复声明“路径加 /api/v1/”“响应包一层 Result”？将这些规则写入项目契约，一次配置长久生效。

• 在项目根目录新建 CODEBUDDY.md。
• 写入通用规则，例如：
  

  API 规范：
  – 所有路径以 /api/v1/ 开头
  – 资源名用复数（users、orders）
  – 成功响应：200（查）、201（创）、204（删）
  – 错误统一返回 { "code": "USER_NOT_FOUND", "message": "...", "timestamp": ... }
  – DTO 禁止含 password、token 字段

• 保存后，后续所有生成操作自动遵循这些规则，无需再重复声明——实现真正的“一劳永逸”。