API 规范 #

这一页记录 Phase 0 已经明确下来的接口约定。

统一规则 #

  • API 版本前缀统一使用 /api/v1
  • 返回结构统一为 codemessagedata
  • 接口文档统一采用 OpenAPI + Swagger UI

设计原则 #

  • 路径语义清晰
  • 请求和响应都要可文档化
  • 前后端对字段名称保持一致

说明 #

  • 目前还没有把所有业务接口展开到文档里
  • 后续新增接口时,先补文档,再补实现