Codex API 契约技能:核对订单状态变更的类型与错误
EnglishCodex 安装步骤
- 从固定 GitHub 提交复制 `.codex/skills/api-contract-guard/` 完整目录到项目 `.agents/skills/api-contract-guard/`。
- 让 Codex 给目标接口写一句话业务能力,再列请求、结果和失败类别。
中文摘要
用业务操作定义 DTO、过滤字段、错误类别和持久化边界,校对调用方与后端的约定。
SKILL.md 中文导读
可复现示例
为本地演示接口设计 `moveOrderToProcessingStatus`。只接收订单 ID 和目标状态,分别定义有效转换、无效转换与订单不存在的结果。工作步骤
- 将状态变更与读取分开,检查参数名、客户端类型和后端序列化一致。
- 用本地夹具覆盖成功、无效状态和缺记录,报告每个结果对应的契约。
验收方法
契约说明请求字段、成功响应、两个错误类型及何时落库,调用方与存储层能追踪同一语义。
GitHub 原文 · 更新日期
适用环境
需要本地 API 设计或代码、类型定义和合成请求示例。
常见问题
接口名应该直接沿用底层存储方法名吗?
先按调用者要完成的业务动作命名。底层存储名称可以反映实现细节。