Appearance
系统行为概述
本节描述系统的通用行为规则,这些规则跨越多个 API 端点统一适用。
行为规则一览
| 规则 | 说明 | 详情 |
|---|---|---|
| 错误码 | HTTP 状态码和 WebSocket 错误码定义 | 错误码与状态码 |
| 分页排序 | 列表端点的标准查询参数 | 分页与排序 |
| 速率限制 | 各接口的频率限制 | 速率限制 |
| 资源锁定 | WebSocket 连接的独占锁机制 | 资源锁定 |
| 权限作用域 | 资源访问控制的三维度模型 | 权限与作用域 |
通用约定
字段命名
- 所有 JSON 字段使用
snake_case命名 - 日期时间使用 ISO 8601 格式(带时区)
- ID 使用 UUID v4 格式
- 金额使用整数表示(单位:分)
空值处理
null表示"未设置"或"不存在"- 空字符串
""不会出现在可选字段中(可选字段要么有值,要么为null) - 空数组
[]表示"列表为空"(不同于null)
更新操作
PATCH请求只需发送需要更新的字段- 未包含的字段保持原值不变
- 发送
null可以清除可选字段的值
删除操作
DELETE成功返回204 No Content- 删除不存在的资源返回
404 - 有级联关系的资源删除行为取决于具体资源