DiagramPreview
高级预览Live previewBrowser workflowExport SVG

API 错误流程图

把 API 状态码、失败条件、重试规则和恢复动作整理成错误流程图,用于 API 文档、故障 runbook、SDK 交接和客户端集成评审。

示例
预览就绪
生成结果会显示在这里。

下一步可以继续

把当前预览结果带到相关工具里继续转换、排查或导出。

API 排障工作流openapi-to-sequencepostman-collection-sequence-diagramhar-file-sequence-diagramapi-error-flow-diagram

使用方法

  1. 1按状态码、失败条件、恢复动作的格式粘贴 API 错误行。
  2. 2预览生成的流程图,检查可由用户修复的错误、认证失败、冲突、限流和服务端故障是否分支清楚。
  3. 3补充业务错误码、是否可重试、Retry-After、告警和日志排查动作。
  4. 4导出图表,用于 API 文档、runbook、SDK 说明或架构评审。

常见场景

API 错误处理文档状态码决策树重试与降级 runbook客户端集成评审故障响应流程

常见问题

怎么生成 API 错误流程图?

把每个状态码、失败条件和恢复动作列成一行,然后预览流程图。建议把参数校验、认证失败、冲突、限流、依赖超时和服务端错误拆成不同分支。

API 错误流程图应该包含什么?

建议包含 HTTP 状态码、稳定的业务错误码、客户端是否可以重试、用户看到的处理动作,以及服务端排查需要看的日志、指标或告警。

可以描述重试策略吗?

可以。在恢复动作里写清楚是否重试、重试一次、指数退避、遵守 Retry-After,或者因为请求非幂等而不能重试。

可以配合 AI 生成内容使用吗?

可以。先用 AI 生成初稿,再在这里预览、检查和调整,最后放进文档。

什么时候比状态码表格更适合?

表格适合查阅,流程图适合评审分支逻辑、重试路径、降级动作,以及什么时候从客户端处理转为运维响应。

API 错误流程图可以把状态码表格变成更容易评审的流程图,适合 API 文档、SDK 交接、客服排障、故障复盘和 runbook。

用它区分参数校验错误、认证失败、业务冲突、限流、依赖故障和可重试的服务端错误,让客户端和后端都知道下一步动作。

建议把源错误行和导出的图表一起保存,这样 API 错误码调整时,可以继续维护流程图,而不是重新画一张截图。

示例:把 API 错误处理画成流程

错误流程图能把状态码、客户端行为、重试规则和恢复动作放在一起评审,避免错误处理只停留在表格里。

  • 把用户可修复错误和服务端、依赖故障分开。
  • 明确标出哪些响应可以安全重试。
  • 给线上故障补充日志、指标或告警排查动作。
400 invalid input -> show field error
401 unauthorized -> refresh token
503 timeout -> retry with backoff

API 错误流程图评审清单

错误流程图能帮助团队判断一个状态码是否承载了太多不相关问题,也能让 SDK、前端和后端对恢复动作达成一致。

  • 检查每个错误响应是否有稳定的 code 和 message。
  • 写清楚客户端是否可以重试,以及重试条件。
  • 把关键运行时错误映射到日志、指标和告警。
输入 -> 预览 -> 检查风险字段 -> 修改源码 -> 导出或分享

API 错误流程图 检查清单

当你需要在文档、PR、故障复盘或交接材料发布前检查源码内容时,可以使用 API 错误流程图。把 API 状态码、失败条件、重试规则和恢复动作整理成清晰的错误流程图。

导出前建议检查标签是否可读、关系是否和源码一致、示例是否包含敏感信息,以及修改输入后预览是否仍然成立。

限制与排查

如果预览失败,先把输入缩小到最小完整示例,确认格式语法,再逐段加回内容。很多失败来自不完整文件、缩进错误、缺少图表头,或复制了依赖隐藏上下文的片段。

请把预览结果当作 review 界面,而不是生产事实来源。生成的图表、转换文件、看板和规则示例在进入正式文档或运维流程前仍需要人工确认。

可测试的示例输入

  • Checkout API: 400 | Invalid cart payload | Return validation details 401 | Missing access token | Ask client to authenticate 409 | Inventory changed | Refresh cart and retry 422 | Payment method...
  • Auth API: 400 | Password policy failed | Show policy requirements 401 | Wrong credentials | Return generic login error 403 | Account locked | Start recovery flow 429 | Too many attempts | Ap...
  • Rate limit: 429 | Request burst exceeded | Return Retry-After header 503 | Global throttle enabled | Route to degraded mode 500 | Quota store unavailable | Fail closed for write endpoints

工具完成度

高级预览

高级解析

这个工具会从开发者输入中提取结构和关系,适合调试与文档 review;复杂边界仍建议回到源码确认。

分级不是质量打分,而是告诉用户当前工具更适合稳定导出、深度调试、快速解析,还是 AI 辅助生成。