CodeBuddy 自动生成 API 接口并非简单“一键生成”那般轻率。关键在于清晰表达意图、明确指定路径、完整配置上下文——只需告知所需资源、HTTP 方法以及返回结构，它便能依据规范产出可执行的代码，绝非笼统地“做个接口”就能应付。
通过自然语言指令快速生成 API 接口（日常首选）
从零开始构建模块？只需一条指令即可触发全栈代码生成，干脆利落。
- 终端进入项目根目录，确认已登录：
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 逆向生成 API 接口（高效省力）
已有表结构？无需重新编写业务逻辑，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 规范（一劳永逸）
不想每次重复声明“路径加 /api/v1/”“响应包裹 Result”？写入项目契约，一劳永逸。
- 在项目根目录新建
CODEBUDDY.md。 - 写入通用规则，例如：
API 规范：
– 所有路径以 /api/v1/ 开头
– 资源名使用复数（users、orders）
– 成功响应：200（查询）、201（创建）、204（删除）
– 错误统一返回 { "code": "USER_NOT_FOUND", "message": "...", "timestamp": ... }
– DTO 禁止包含 password、token 字段 - 保存后，后续所有生成操作自动遵循这些规则，无需重复声明——这才是真正的“一劳永逸”。