SuperAPI AI 工具集

error-taxonomy

编程与开发

查看项目

更新于 10-15 19:49

技能介绍

用途:在 FastAPI 后端与 Next.js 前端之间建立统一的错误分类,使每个错误都具备错误码、类别、严重级别与用户提示,避免前后端错误处理不一致。

主要能力:错误码采用 DOMAIN_CATEGORY_SPECIFIC 格式,例如 AUTH_VALIDATION_INVALID_TOKEN、AGENT_RUNTIME_TIMEOUT、DATA_VALIDATION_MISSING_FIELD。域前缀包括 AUTH_、AGENT_、DATA_、WORKFLOW_、SYS_;类别包括 VALIDATION、RUNTIME、PERMISSION、NOTFOUND、CONFLICT、RATELIMIT、EXTERNAL;严重级别分为 fatal(500-599)、error(400-499)、warning(200 带警告头)。后端以 ErrorResponse 模型(detail、error_code、severity、field)作为标准错误响应,并注册全局处理程序把 Pydantic ValidationError 转成结构化响应;前端以 ApiClientError 类承载状态码、错误码、严重级别和字段,并提供 isAuth、isValidation、isRetryable 判断及 ERROR_MESSAGES 用户提示映射。

使用方式:新增错误码时先选域、再选类别、加具体标识,登记到错误码注册表,并在前端 ERROR_MESSAGES 中补充对应提示;抛出错误时使用 ErrorResponse 模型而非纯字符串。

适用场景:创建或修改 API 错误响应、在 FastAPI 路由中新增 HTTPException、实现前端错误展示或 React 错误边界、审查前后端错误一致性时使用。

限制与边界:重试与容错逻辑应改用 retry-strategy;React 错误边界组件设计应改用 error-boundary;构建、lint、类型错误不属于此技能范围。新增错误码若造成破坏性变更需提升版本。