Skip to content

约定与规范 ​

分页 ​

所有列表接口均支持分页,默认 page=1, page_size=20,最大 page_size=100。

时间格式 ​

  • 请求和响应中的时间字段统一使用 YYYY-MM-DD HH:mm:ss 格式(如 2025-08-05 10:30:00)
  • 时区为 Asia/Shanghai(UTC+8)

敏感数据 ​

开放接口默认返回完整数据(不脱敏),内部系统间传递完整信息。

如你的客户端被配置了脱敏(sanitize_enabled=1),以下字段会被处理:

字段脱敏规则示例
phone中间四位替换为 *138****8000
id_card中间十位替换为 *310***********1234
wechat中间部分替换为 *wx****id

排序 ​

支持排序的接口,可通过 order_by 和 order_dir 参数控制排序:

  • order_by:排序字段名
  • order_dir:desc(降序,默认)或 asc(升序)

幂等性 ​

  • GET 请求天然幂等
  • POST 创建接口:通过业务唯一键防重(如手机号),重复创建返回 HTTP 409
  • PUT 更新接口:幂等,多次相同请求结果一致
  • 批量接口:单条失败不影响其他条目