standards/response_code_standard.md

响应码规范

1. 基本原则

• 响应码 0 表示成功
• 非 0 响应码表示失败
• 响应码应当具有明确的业务含义
• 错误响应码应当与错误信息相对应

2. 响应格式

{
    "code": 0,           // 响应码：0表示成功，非0表示失败
    "message": "string", // 响应消息：成功或错误描述
    "data": {}          // 响应数据：成功时返回数据，失败时可能为null
}

3. 标准响应码定义

3.1 成功响应

响应码	说明	使用场景
0	成功	请求成功完成

3.2 错误响应

响应码	说明	使用场景
400	请求参数错误	参数格式错误、必需参数缺失等
401	未授权	未登录或token无效
403	权限不足	无权限访问该资源
404	资源不存在	请求的资源不存在
500	系统内部错误	服务器内部错误

4. 测试要求

4.1 成功场景测试

• 验证响应码为 0
• 验证 message 为成功提示
• 验证 data 包含预期数据

4.2 失败场景测试

• 验证响应码为对应错误码
• 验证 message 包含具体错误信息
• 验证错误码与错误场景匹配

5. 最佳实践

5.1 错误码设计原则

1. 错误码应具有可读性
2. 错误码应与错误消息配对使用
3. 避免使用未定义的错误码

5.2 错误消息要求

1. 消息内容应清晰明确
2. 包含必要的错误详情
3. 避免暴露敏感信息