通用约定

为降低对接成本，本站文档采用统一的命名与返回结构约定（教学示意）。

路径与方法

• 路径前缀：/api/
• 资源名使用小写与中划线/单词路径，如 /api/image/random
• 查询类优先使用 GET；可能较长的 body 使用 POST

字符编码与时间

• 统一 UTF-8
• 时间戳默认秒级 Unix Timestamp，必要时提供毫秒字段
• 可读时间建议同时给出 ISO8601

统一响应结构

{
  "code": 0,
  "msg": "success",
  "data": {},
  "request_id": "可选，便于排查"
}

HTTP 状态码建议

• 200：请求已被处理（业务成功/失败以 code 为准）
• 400：参数错误
• 401/403：鉴权失败（若启用鉴权）
• 429：请求过于频繁
• 500：服务端异常

频率与安全