「短网址服务」错误码规范

短网址服务错误码规范(整数版,10/11/12/13/14 前缀) 1. 错误码设计规则 格式:XXYYZZ XX:模块前缀(两位整数) YY:子分类(可选) ZZ:错误序号(递增) 2. 模块划分 10xxxx → 通用错误(Common) 11xxxx → 用户与认证(Auth/User) 12xxxx → 短链服 …

短网址服务错误码规范(整数版,10/11/12/13/14 前缀)

1. 错误码设计规则

  • 格式:XXYYZZ

    • XX:模块前缀(两位整数)
    • YY:子分类(可选)
    • ZZ:错误序号(递增)

2. 模块划分

  • 10xxxx → 通用错误(Common)
  • 11xxxx → 用户与认证(Auth/User)
  • 12xxxx → 短链服务(URL/Shorten)
  • 13xxxx → API & Dashboard
  • 14xxxx → 统计与报表(Stats/Report)

3. 错误码表

通用错误(10xxxx)

错误码HTTP 状态描述前端提示
100001400参数不合法输入有误,请检查后重试
100002429请求过于频繁操作过于频繁,请稍后再试
100003500系统内部错误系统开小差了,请稍后再试

用户与认证(11xxxx)

错误码HTTP 状态描述前端提示
110001400邮箱格式不合法邮箱格式错误,请重新输入
110002409邮箱已注册该邮箱已被注册,请直接登录
110003401登录失败(账号/密码错误)邮箱或密码不正确,请重试
110004401Token 无效或过期登录已过期,请重新登录
110005403权限不足您没有权限执行此操作
110006400Refresh Token 无效登录状态已失效,请重新登录

短链服务(12xxxx)

错误码HTTP 状态描述前端提示
120001400长链格式不合法链接格式不正确,请输入有效网址
120002400长链过长链接过长,请缩短后重试
120003403URL 在黑名单中该链接无法生成短网址
120004409自定义短码已存在短码已被使用,请更换后重试
120005404短链不存在短链不存在或已被删除
120006410短链已过期短链已过期,请重新生成
120007500短链生成失败短链生成失败,请稍后再试

API & Dashboard(13xxxx)

错误码HTTP 状态描述前端提示
130001401API Key 无效API Key 无效,请检查配置
130002403API Key 权限不足API Key 权限不足,请联系管理员
130003429API 调用超限API 调用次数超出限制,请稍后再试
130004404短链记录未找到未找到相关短链记录
130005400参数错误(分页/筛选非法)请求参数错误,请检查后重试

统计与报表(14xxxx)

错误码HTTP 状态描述前端提示
140001404没有找到统计数据暂无统计数据
140002400时间区间不合法时间范围选择有误
140003500聚合统计失败数据统计失败,请稍后再试

4. 返回示例

成功

{
  "code": 0,
  "message": "success",
  "data": {
    "short_url": "https://s.io/abc123"
  }
}

短码冲突(120004)

{
  "code": 120004,
  "message": "Custom short code already exists",
  "data": null
}

Token 过期(110004)

{
  "code": 110004,
  "message": "Token expired or invalid",
  "data": null
}

API 超限(130003)

{
  "code": 130003,
  "message": "API rate limit exceeded",
  "data": null
}

接口与错误码映射表

1. 用户认证模块

POST /api/auth/register

  • 成功 → code = 0

  • 可能错误码:

    • 100001 参数不合法(邮箱/密码缺失)
    • 110001 邮箱格式不合法
    • 110002 邮箱已注册
    • 100003 系统内部错误

POST /api/auth/login

  • 成功 → code = 0

  • 可能错误码:

    • 100001 参数不合法(邮箱/密码缺失)
    • 110003 登录失败(账号/密码错误)
    • 100003 系统内部错误

POST /api/auth/refresh

  • 成功 → code = 0

  • 可能错误码:

    • 110006 Refresh Token 无效
    • 110004 Token 过期/无效
    • 100003 系统内部错误

POST /api/auth/logout

  • 成功 → code = 0

  • 可能错误码:

    • 110004 Token 过期/无效
    • 100003 系统内部错误

2. 短链服务模块

POST /api/shorten

  • 成功 → code = 0

  • 可能错误码:

    • 100001 参数不合法(长链缺失)
    • 120001 长链格式不合法
    • 120002 长链过长
    • 120003 URL 在黑名单中
    • 120004 自定义短码已存在
    • 100003 系统内部错误

GET /{short_code} (跳转接口)

  • 成功 → HTTP 302 跳转

  • 可能错误码:

    • 120005 短链不存在
    • 120006 短链已过期
    • 100003 系统内部错误

DELETE /api/{short_code}

  • 成功 → code = 0

  • 可能错误码:

    • 110005 权限不足(试图删除非本人短链)
    • 120005 短链不存在
    • 120006 短链已过期
    • 100003 系统内部错误

GET /api/info/{short_code}

  • 成功 → code = 0

  • 可能错误码:

    • 120005 短链不存在
    • 120006 短链已过期
    • 100003 系统内部错误

GET /api/list?page=1&size=20

  • 成功 → code = 0

  • 可能错误码:

    • 100001 参数不合法(分页参数错误)
    • 100003 系统内部错误

3. API & Dashboard 模块

GET /api/dashboard/urls

  • 成功 → code = 0

  • 可能错误码:

    • 110004 Token 无效/过期
    • 130005 参数错误(筛选非法)
    • 100003 系统内部错误

POST /api/dashboard/apikeys

  • 成功 → code = 0

  • 可能错误码:

    • 110004 Token 无效/过期
    • 100001 参数不合法
    • 100003 系统内部错误

DELETE /api/dashboard/apikeys/{id}

  • 成功 → code = 0

  • 可能错误码:

    • 110005 权限不足
    • 130004 API Key 未找到
    • 100003 系统内部错误

4. 统计与报表模块

GET /api/stats/{short_code}

  • 成功 → code = 0

  • 可能错误码:

    • 120005 短链不存在
    • 140001 没有找到统计数据
    • 140002 时间区间不合法
    • 100003 系统内部错误

GET /api/stats/trends

  • 成功 → code = 0

  • 可能错误码:

    • 140002 时间区间不合法
    • 100003 系统内部错误

5. API 限流场景(所有接口通用)

  • 100002 请求过于频繁
  • 130003 API 调用超限

继续阅读

探索更多技术文章

浏览归档,发现更多关于系统设计、工具链和工程实践的内容。

全部文章 返回首页