要让CodeBuddy在接口调试过程中持续遵循统一API规范,关键在于确保CODEBUDDY.md文件被正确识别、实时生效且不被意外覆盖。一旦这个文件配置路径有误或位置跑偏,后续生成的接口代码将偏离RESTful约定,导致联调时反复返工。

确认CodeBuddy是否成功读取CODEBUDDY.md
CodeBuddy仅会在项目根目录下主动加载CODEBUDDY.md,不会向上递归查找父目录中的文件。如果当前工作目录并非项目根目录,该文件实际等同于不存在。
如何验证文件是否被读取?执行命令:/config show,然后检查输出中是否包含 【Loaded CODEBUDDY.md from /path/to/your/project】 这一行。若未看到此提示,说明CodeBuddy根本未找到文件——无论内部规范写得多完善,都不会对代码生成产生任何影响。
CODEBUDDY.md内容校验与最小必要结构
文件必须以UTF-8无BOM编码保存,首行不能为空行或注释,否则解析失败后CodeBuddy会静默回退至默认规则,且不给出任何报错。
基础可用结构(仅限定路径与动词规则)
写入以下三行即可触发基本的RESTful识别:
API规范:所有接口路径以/api/v1/开头 资源名使用复数名词(如users、orders) 使用标准HTTP动词(GET/POST/PUT/PATCH/DELETE)
这实质上是一个最小契约——告知CodeBuddy路径格式、资源命名方式以及动词使用方法。
完整生产级结构(包含状态码与响应契约)
若用于实际生产环境,须严格包含四类字段:路径前缀、资源命名、动词映射、响应语义。缺少任何一项,CodeBuddy都会对缺失项采用默认值——例如状态码全部默认返回200,调试时HTTP状态码对不上,排查半天才发现问题根源在此。
特别留意:CODEBUDDY.md中切勿使用Markdown标题(如#、##)或代码块```包裹内容。CodeBuddy的解析器不支持Markdown语法,仅识别纯文本行内以冒号分隔的键值对。遇到#或```时,整行会被跳过,配置即时失效。
多项目切换时验证CODEBUDDY.md自动加载
若同时维护多个项目,切换时务必确认每个项目的CODEBUDDY.md均正确加载。具体验证步骤如下:
第一步:在终端进入项目A根目录,输入 /folder /path/to/project-a,待右上角路径更新完成;
第二步:立即执行 /config show,确认输出中显示的是project-a的CODEBUDDY.md路径;
第三步:切换至项目B,输入 /folder /path/to/project-b,再次运行 /config show;
第四步:对比两次输出中的“Loaded CODEBUDDY.md”路径,应分别指向各自项目根目录。
若第二次仍显示project-a的路径,说明project-b根目录下要么不存在CODEBUDDY.md,要么文件名大小写不匹配(如codebuddy.md或CODEBUDDY.MD)。
