# 13 — 接口文档（对照原型）

**What to build:** 全模块开发完成后，对照原型界面产出/完善客户模块接口文档，保证每个原型界面用到的接口契约齐全、参数/出参/状态码/权限/脱敏规则齐备且与实现一致。交付一份可供前端与联调直接使用的接口文档。

**Blocked by:** 01–11（全部功能票完成）；建议在 12 原型对齐后或并行进行

**Status:** ready-for-agent

**文档载体**：复用现有 knife4j/swagger（OpenAPI）注解体系（对称 crm-opportunity 的 `@Schema`/`@Operation` 写法）；接口文档以 knife4j 在线文档为主、必要时补一份 Markdown 汇总。

- [ ] 按原型界面梳理接口清单（每个界面→其依赖的接口），确保无遗漏、无孤立接口
- [ ] 客户 CRUD / 查重（票 02）：请求/响应 DTO 的 `@Schema` 描述齐全；查重弹窗返回结构（相似候选/脱敏字段）文档化
- [ ] 联系人 CRUD + 搜索 + quick-create（票 03）：含商机侧硬依赖接口 `search`/`contacts`/`quick-create` 契约
- [ ] 三 workspace 列表 + 归属流转（票 04）：分页出参、看板分组出参、各归属动作入参/前置校验错误码
- [ ] 详情 8 页签 + 跟进 + oplog（票 06）：各页签接口、分页/分组/过滤参数、失败显"--"约定
- [ ] 交割（票 07）/ 导入（票 08）/ 提醒配置（票 09）/ saved-view（票 10）接口契约
- [ ] 统一标注：权限（RBAC 功能权限 / @DataScope 数据范围）、字段级脱敏规则、错误码与业务含义
- [ ] 校验：文档中每个接口都能在 knife4j 中打开并与实现签名一致；参数示例可直接联调
- [ ] 与票 12 对齐结果保持同步——原型对齐中修正的接口同步更新文档