返回文章列表
后端架构示例文章

给 API 设计一套清晰的错误约定

让前端知道发生了什么,也让后端知道该从哪里排查。错误码、用户提示与日志,需要各司其职。

错误也是接口的一部分

成功返回值通常有明确结构,错误却常常只剩下一句“系统异常”。为错误定义稳定的结构,可以减少调用方的猜测。

一个简单的结构

json
{
  "code": "ARTICLE_NOT_FOUND",
  "message": "这篇文章不存在或尚未发布"
}

区分不同读者

用户需要知道下一步可以做什么。开发者需要稳定的错误码与请求标识。完整堆栈应保留在服务端日志中。

保持 HTTP 语义

校验失败、未登录、无权限和资源不存在,应采用对应的 HTTP 状态码。客户端才能做出合理的重试、登录和展示决策。

© 2026 码间 · 保持好奇,持续记录。写作后台