示例:把 API 错误处理画成流程
错误流程图能把状态码、客户端行为、重试规则和恢复动作放在一起评审,避免错误处理只停留在表格里。
- 把用户可修复错误和服务端、依赖故障分开。
- 明确标出哪些响应可以安全重试。
- 给线上故障补充日志、指标或告警排查动作。
400 invalid input -> show field error
401 unauthorized -> refresh token
503 timeout -> retry with backoff把 API 状态码、失败条件、重试规则和恢复动作整理成错误流程图,用于 API 文档、故障 runbook、SDK 交接和客户端集成评审。
把当前预览结果带到相关工具里继续转换、排查或导出。
把每个状态码、失败条件和恢复动作列成一行,然后预览流程图。建议把参数校验、认证失败、冲突、限流、依赖超时和服务端错误拆成不同分支。
建议包含 HTTP 状态码、稳定的业务错误码、客户端是否可以重试、用户看到的处理动作,以及服务端排查需要看的日志、指标或告警。
可以。在恢复动作里写清楚是否重试、重试一次、指数退避、遵守 Retry-After,或者因为请求非幂等而不能重试。
可以。先用 AI 生成初稿,再在这里预览、检查和调整,最后放进文档。
表格适合查阅,流程图适合评审分支逻辑、重试路径、降级动作,以及什么时候从客户端处理转为运维响应。
API 错误流程图可以把状态码表格变成更容易评审的流程图,适合 API 文档、SDK 交接、客服排障、故障复盘和 runbook。
用它区分参数校验错误、认证失败、业务冲突、限流、依赖故障和可重试的服务端错误,让客户端和后端都知道下一步动作。
建议把源错误行和导出的图表一起保存,这样 API 错误码调整时,可以继续维护流程图,而不是重新画一张截图。
错误流程图能把状态码、客户端行为、重试规则和恢复动作放在一起评审,避免错误处理只停留在表格里。
400 invalid input -> show field error
401 unauthorized -> refresh token
503 timeout -> retry with backoff错误流程图能帮助团队判断一个状态码是否承载了太多不相关问题,也能让 SDK、前端和后端对恢复动作达成一致。
输入 -> 预览 -> 检查风险字段 -> 修改源码 -> 导出或分享当你需要在文档、PR、故障复盘或交接材料发布前检查源码内容时,可以使用 API 错误流程图。把 API 状态码、失败条件、重试规则和恢复动作整理成清晰的错误流程图。
导出前建议检查标签是否可读、关系是否和源码一致、示例是否包含敏感信息,以及修改输入后预览是否仍然成立。
如果预览失败,先把输入缩小到最小完整示例,确认格式语法,再逐段加回内容。很多失败来自不完整文件、缩进错误、缺少图表头,或复制了依赖隐藏上下文的片段。
请把预览结果当作 review 界面,而不是生产事实来源。生成的图表、转换文件、看板和规则示例在进入正式文档或运维流程前仍需要人工确认。
这个工具会从开发者输入中提取结构和关系,适合调试与文档 review;复杂边界仍建议回到源码确认。
分级不是质量打分,而是告诉用户当前工具更适合稳定导出、深度调试、快速解析,还是 AI 辅助生成。