给接口列清失败模式
收录 2026-11-01
超时、部分成功、重复提交——把调用方会遇到的错误先写清。
下面有一个接口定义。请：1）列出 5 种失败模式（超时、部分成功、重复提交、权限过期、下游不可用）；2）每种写明调用方会看到什么、服务端应返回什么状态码或错误码；3）每种给出调用方正确的处理策略（重试、放弃、对账、降级）；4）指出哪种最容易被开发者忽略、上线后才暴露；5）给出一条能写进文档的一句话说明。不要只写「返回 500」。
本站原创
中文原文
使用建议
接口文档里没写的失败，线上都会出现。
可以这样改
- 要求它先复述需求与约束，确认无误再写代码。
- 让它给出最小改动 + 回滚方式，而不是整文件重写。
交付物（这次应拿到什么）
- 可运行的最小改动（含直接可用的代码块）
- 影响面清单：改了哪些文件、哪些调用点要跟着改
常见错法
- 一次让它改十个文件，最后分不清哪处改动导致了新问题。
- 只贴报错不贴代码和版本，拿到无法落地的修法。
输出验收（怎么判断能用）
- 改动可运行、可回滚，且没顺手改无关代码。
- 边界条件（空值、超长、并发）有说明或测试。
适用场景与注意
- 适合：让它先复述需求和约束，再给最小可运行改动。
- 注意：贴报错时同时给版本号与最小复现，否则它容易给出看似合理但不适配的写法。