Skip to content

Latest commit

 

History

History
54 lines (42 loc) · 2 KB

File metadata and controls

54 lines (42 loc) · 2 KB

API.md

权限:agent可读写|规则:直接更新;只追加不删旧(旧条目标记"被更新")|作用:接口定义、参数、响应、错误码、变更历史。涉及接口变更时查阅,修改接口后更新。


使用说明

  • 涉及接口新增、修改、废弃时,必须先查阅本文件确认现状。
  • agent可直接读写本文件,但每次接口变更必须在 CHANGELOG.md 留痕。
  • 接口变更后,若影响模块调用关系,需同步更新 MODULE.md。
  • 旧接口废弃时,不得删除条目,标记为"被更新"并注明替代接口。
  • 新增接口若涉及技术选型,需在 DECISION.md 留决策记录。
  • 分片触发:当本文件接口数超过 50 个时,按业务域拆分到各模块契约(modules/MODULE_XXX.md)的"对外接口"章节,本文件降级为接口索引(仅保留 API-ID 和归属模块)。分片后修改接口只需读对应模块契约。

待填入基线

  • 接口风格:(RESTful / GraphQL / RPC 等)
  • 基础URL约定:
  • 鉴权方式:
  • 统一响应格式:
  • 错误码体系:
  • 版本管理策略:
  • 分页/排序/过滤统一约定:(参数名 / 默认页大小 / 上限 / 排序方向标识)
  • 幂等性约定:(哪些接口必须幂等 / 幂等键机制 / 幂等有效期)
  • 版本兼容策略:(破坏性变更处理流程 / deprecation周期 / 兼容期时长)
  • 限流/熔断/降级:(限流策略与阈值 / 熔断触发条件 / 降级方案)
  • 接口分组:(按业务域划分 / 路径前缀约定 / 分组与模块的对应关系)

接口清单

新增接口时按以下格式追加:

### [API-ID] [接口名称]
- 所属分组:
- 路径:
- 方法:
- 鉴权要求:
- 幂等性:(是/否,幂等键字段)
- 请求参数:
- 响应格式:
- 请求示例:
- 响应示例:
- 错误码:
- 超时/重试策略:
- 说明:

(接口条目由agent在项目开发过程中按上述格式追加)


变更历史:见 .git + CHANGELOG.md