跳到主要内容

API 规范

本页用于维护 API 调用和设计规范。

建议统一约定:

  • URL 使用清晰的业务资源路径。
  • 查询类接口优先使用 GET,提交或操作类接口使用 POST
  • 时间字段统一使用 ISO 8601 或明确的本地时间格式。
  • 分页参数统一命名为 pagepageSize
  • 破坏性 API 变更需要提前通知调用方。