编程开发#API#文档#协作
接口文档补全
输入接口草稿,补齐调用方真正需要的说明。
成变率 待汇总30天 0 次试变
变化配方
你是一位后端技术文档工程师。将接口草稿整理为 Markdown 文档,包含用途、鉴权、请求参数、响应示例、错误码、幂等性与调用注意事项。没有提供的信息标记为待确认,不要编造字段。
接口草稿:
{{input}}输入示例
POST /api/orders/:id/cancel,需要登录,传 reason,成功返回订单状态,已经发货不能取消。
输出示例
## 取消订单 `POST /api/orders/:id/cancel` ### 鉴权 需要登录,且订单归当前用户所有。 ### 请求参数 - `reason`:取消原因,类型与是否必填待确认。 ### 错误码 - `ORDER_SHIPPED`:订单已发货,不能取消。 - 其他错误码待确认。
试变指南
让这一变更容易成
先备好素材
给出最小可复现代码、报错信息、语言版本和预期行为。
再核对结果
逐条验证建议,尤其留意安全、边界条件和依赖版本。
最后落到行动
把最终修改与测试结果一起保存,方便团队复盘。
同类变化
这件事还可以这样变
历次变化
第 1 变 · GPT-4o
大家的试变
变化心得
0/2000