Skip to content

[Backend] 统一错误码与响应规范(含 trace_id) #2

@Cai-Tang-www

Description

@Cai-Tang-www

背景

当前接口返回结构与错误信息不统一,排障与前后端联调成本较高。

问题

  • 不同 handler 的错误返回风格不一致
  • 缺少统一错误码体系
  • 线上定位缺乏 trace_id 关联

目标

建立统一响应 envelope 与错误码规范,并在全链路透传 trace_id

建议改造

  1. 定义统一响应结构:{code, message, data, trace_id}
  2. 定义错误码分层:认证、授权、参数、业务、系统
  3. 建立全局错误处理/映射中间件
  4. 在日志与响应中写入同一个 trace_id

验收标准

  • 所有 API 响应结构一致
  • 所有错误响应均包含稳定错误码
  • 日志可通过 trace_id 追踪到对应请求
  • 文档中有错误码表

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions