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.
 
 
 
 
 

1.7 KiB

06 — 建立 Bruno A4 端点与返回类型映射清单

Type: task Status: resolved

Question

D:\code\crm-api-docs\A4 客户管理\ 下排除 folder.bru 的 117 个 .bru 文件为端点全集,建立票 03 可执行的唯一输入清单:

  1. 逐个识别 .bru 的 HTTP 方法与 URL,并标记其现有“响应 data 结构”是否已有完整 字段 | 类型 | 说明 表和 JSON 示例。
  2. 对每个缺口端点,从对应 Controller、Service、DTO/Entity、既有 defs_a4.py 定义或其他可追溯源码定位 response.data 的返回形态;记录 PageResult<T>List<T>、单 DTO、空响应、标量、内联结构及无法可靠推断的情况。
  3. 每条映射必须给出来源文件和定位信息;无法可靠推断时明确列为人工决定项,不得臆造 DTO 或字段。
  4. 将结果写为 .scratch/a4-doc-fields/canonical-endpoint-response-mapping.md,并统计端点总数、既有完整数、待补字段表数以及各返回形态数量。

该清单是票 03 的唯一写回范围和返回类型输入;票 03 只能修改其中标记为“待补且可生成”的端点,其余边界项须保留原文并在验收中单列说明。

Answer

已生成 A4 Bruno 端点与返回类型映射清单

  • 以 Bruno A4 目录中 117 个非 folder.bru 文件为全集,全部从 Controller 静态解析到返回类型与源码位置。
  • 形态统计:分页 16、对象 37、列表 14、二进制 3、空响应 35、标量 12。
  • 映射和补丁工具见 complete_a4_doc_fields.py,它扫描 crm-customercrm-basecrm-preference,并支持 DTO、继承字段及嵌套 record(CompanyCandidate)。