You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
17 lines
1.9 KiB
17 lines
1.9 KiB
3 days ago
|
# 06 — Bruno 接口文档生成 + 真实示例注入
|
||
|
|
|
||
|
|
`Type:` task · `Status:` claimed · `Blocked by:` 04, 05
|
||
|
|
|
||
|
|
## Question
|
||
|
|
|
||
|
|
交付**两件套之一：Bruno 接口文档集合**——`E:\code\crm-api-docs\A4 客户管理\` 下 55 端点按原型页面分组 .bru（子目录结构参照 A3 商机管理：页面级目录 + folder.bru + README.md），示例值来自票 04/05 的 specimens.json 真实实测值。
|
||
|
|
|
||
|
|
工作项：
|
||
|
|
|
||
|
|
- **动手前先读**：`C:\Users\Administrator\.qoder\skills\bruno-sync` skill 机制 + 根目录 `bruno-sync.config.json`（sourceRoots 需加 `crm-customer/src/main/java`；本票也可对称商机票 11 用 gen+inject 生成器模式，以「结构听源码、表述听人」铁律为准——手改实参值/示例再生时逐字保留，对账钥匙 = METHOD + 路径）。
|
||
|
|
- **原型页面→接口分组齐全**（API-SUMMARY.md 分组为底稿 + 票 01 原型一手核对）：每个 A4 页面对应的接口无遗漏、无孤立接口；跨模块依赖端点（crm-rule 提醒配置、crm-preference saved-view、商机侧硬依赖三端点）分组归属在此票定（建议规则配置入 A7 后台设置或 A4 内子目录，与 A3 商机规则族先例对齐）。
|
||
|
|
- **描述齐备**：参数/出参字段说明（中文，@Schema 为源）、状态码（67001–67016 + 64023 + 66001 等跨模块码与业务含义）、权限标注（RBAC fail-open + @DataScope(module=customer)）、脱敏现状（masked 字段列明）、错误响应示例。
|
||
|
|
- **对账收口**：生成后对账（verify_sync 或等价）确认钥匙全命中、sync 重跑不动、实参值受铁律保护不丢；A4 目录下 folder.bru/README.md 补全。
|
||
|
|
- **agent 不提交 git**（用户审查后自行提交——bruno-coldstart 既有约定）。
|
||
|
|
- ⚠ 集合根目录现为裸 collection（无 workspace.yml）：若用户 Bruno 3.x 打不开，按 bruno-coldstart 先例升级 workspace 结构（Not-yet 挂号，动手前问用户）。
|