SuperAPI AI 工具集

error-responses

通用与其它

查看项目

更新于 10-16 02:31

技能介绍

用途:该技能用于在 API 中实现错误处理、向客户端返回错误响应、在控制器中捕获异常,或当有人要求“直接把错误消息返回”时提供规范。核心原则是绝不向客户端暴露原始错误消息或堆栈跟踪,无论出于调试、内部 API、开发环境还是前端需要细节的理由都不例外。

主要能力:定义统一的错误响应结构,包含 error.code(机器可读,如 VALIDATION_ERROR)、error.message(人类可读)、可选 details 与 requestId。提供自定义错误类(如 AppError、NotFoundError、ValidationError)与错误处理中间件的模式:服务端记录完整错误(消息、堆栈、路径、方法),对外仅返回安全响应;未知错误统一返回 500 与 INTERNAL_ERROR 及通用消息。同时给出 HTTP 状态码使用建议:400 校验错误、401 未认证、403 未授权、404 未找到、409 冲突、422 不可处理、429 限流、500 服务器错误(隐藏细节)、502 上游失败、503 服务不可用。

使用方式:在路由中捕获异常并交由错误处理中间件(如 next(error)),由中间件按错误类型返回对应状态码与结构化 JSON;调试时通过 requestId 在服务端日志中查找完整信息。

适用场景与限制:适用于各类 API 的错误返回设计,尤其是需要防止泄露数据库结构、内部 IP、文件路径、SQL 查询等信息的场景。资料未提供具体安装命令、依赖或平台限制。