关于 engram-server-api
engram-server-api 是用于维护 HTTP API 路由和契约的开发技能,强调覆盖成功与错误行为的测试,并要求文档与处理程序保持一致。
主要功能
- 01端点契约规范
- 02处理程序级验证测试
- 03端到端路由测试
- 04契约问题回归测试
- 05路由变更时更新文档
适用场景
- 01新增或修改 HTTP 路由
- 02更新请求或响应模式
- 03调整状态码行为
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ gentleman-programming/ engram --skill engram-server-api安装后在 Claude Code 中输入/engram-server-api确认已加载。
详细介绍
适用场景
在以下情况下使用此技能:
- 添加或更改 HTTP 路由
- 更新处理程序的请求/响应架构
- 修改状态码行为
合约规则
- 每个新增或更改的端点都必须有测试。
- 覆盖成功和错误路径。
- 确保脚本和文档与实际处理程序保持一致。
- 不要在插件/钩子中引用不存在的端点。
必需的验证
- 针对解析/验证错误的处理程序级测试
- 针对路由行为和响应正文的 E2E 测试
- 针对每个与 API 合约相关的错误修复添加回归测试
文档规则
如果请求载荷或路由发生更改,请在同一个 PR 中更新文档。
评论
支持 Markdown