Appearance
通用约定
7.1 分页
所有列表接口均支持分页,默认 page=1, page_size=20,最大 page_size=100。
7.2 时间格式
- 请求和响应中的时间字段统一使用
YYYY-MM-DD HH:mm:ss格式(如2025-08-05 10:30:00) - 时区为 Asia/Shanghai(UTC+8)
7.3 敏感数据
开放接口默认返回完整数据(不脱敏),内部系统间传递完整信息。
如你的客户端被配置了脱敏(sanitize_enabled=1),以下字段会被处理:
| 字段 | 脱敏规则 | 示例 |
|---|---|---|
| phone | 中间四位替换为 * | 138****8000 |
| id_card | 中间十位替换为 * | 310***********1234 |
中间部分替换为 * | wx****id |
7.4 排序
支持排序的接口,可通过 order_by 和 order_dir 参数控制排序:
order_by:排序字段名order_dir:desc(降序,默认)或asc(升序)
7.5 幂等性
- GET 请求天然幂等
- POST 创建接口:通过业务唯一键防重(如手机号),重复创建返回 HTTP
409 - PUT 更新接口:幂等,多次相同请求结果一致
- 批量接口:单条失败不影响其他条目