fischerX/docs/api/error-codes.md

72 lines
1.9 KiB
Markdown

# API 错误码说明
> **文档版本**: v1.0.0
> **创建日期**: 2026-05-25
> **最后更新**: 2026-05-25
> **文档作者**: 后端开发
> **文档状态**: 已发布
> **适用范围**: 前端开发、后端开发
## 目录
- [一、错误码规范](#一错误码规范)
- [二、通用错误码](#二通用错误码)
- [三、业务错误码](#三业务错误码)
---
## 一、错误码规范
错误码格式:`{类型}{模块}{序号}`
| 类型 | 说明 |
|------|------|
| 200 | 成功 |
| 400 | 请求错误 |
| 401 | 未授权 |
| 403 | 禁止访问 |
| 404 | 资源不存在 |
| 500 | 服务器错误 |
---
## 二、通用错误码
| 错误码 | HTTP 状态 | 说明 | 解决方案 |
|--------|----------|------|---------|
| 200 | 200 | 请求成功 | |
| 400001 | 400 | 参数错误 | 检查请求参数 |
| 400002 | 400 | 参数缺失 | 补充必填参数 |
| 401001 | 401 | 未登录 | 请先登录 |
| 401002 | 401 | Token 过期 | 重新登录 |
| 403001 | 403 | 无权限访问 | 联系管理员 |
| 404001 | 404 | 资源不存在 | 检查资源 ID |
| 500001 | 500 | 服务器内部错误 | 联系技术支持 |
---
## 三、业务错误码
### 3.1 用户模块 (1)
| 错误码 | HTTP 状态 | 说明 | 解决方案 |
|--------|----------|------|---------|
| 401101 | 400 | 手机号已注册 | 更换手机号 |
| 401102 | 400 | 验证码错误 | 重新获取验证码 |
| 401103 | 400 | 验证码已过期 | 重新获取验证码 |
### 3.2 支付模块 (2)
| 错误码 | HTTP 状态 | 说明 | 解决方案 |
|--------|----------|------|---------|
| 402201 | 400 | 订单不存在 | 检查订单号 |
| 402202 | 400 | 订单已支付 | 请勿重复支付 |
| 402203 | 400 | 余额不足 | 充值后重试 |
---
> **文档维护**: 本文档由后端开发维护,新增错误码时更新
> **反馈渠道**: 如有问题,请联系后端负责人
> **最后更新**: 2026-05-25
> **文档状态**: 已发布