内部培训
03 第3周D17 项目立项

D17 作业:完成自己模块的设计文档

D17 作业:完成自己模块的设计文档

目标

  • 验证:明确自己模块的职责、接口、数据依赖,产出可指导 D18 开发的设计文档。

场景

  • 设计文档放 docs/training/项目/<姓名>-<模块>/,按 D6 流程提交 PR。

任务(按模块写)

A 代理服务:设计文档内容

  1. 对外 /v1/chat/completions 请求流程(鉴权 → 调 verify → 转发 → 流式返回 → 调 deduct)。
  2. 调用 B 的 verify/deduct 时序(谁先谁后、失败怎么办、超时怎么办)。
  3. 转发的上游端点怎么配(base/model 写配置)。
  4. 你打算怎么用 Claude Code 拆这个模块的步骤。

B 计费引擎:设计文档内容

  1. 三张表 SQL 与字段说明。
  2. verify 的实现逻辑(key 无效/禁用/余额不足分别返回什么)。
  3. deduct 的幂等实现(request_id 重复来了怎么办——返回原结果,不重复扣费)。
  4. 事务范围:扣费 + 记流水在哪一步 BEGIN/COMMIT。

C 管理面板:设计文档内容

  1. 页面清单(用户列表/充值/流水/模型定价)与每个页面调的接口 + 字段映射。
  2. 前端路由与组件拆分。
  3. 怎么接 B 的 admin 接口(base 配置、鉴权头、错误提示)。

D 部署:设计文档内容

  1. 三服务目录结构与各自 Dockerfile 要点。
  2. docker-compose 编排(服务名/端口/依赖/卷)。
  3. 联调脚本思路(起服务 → 充值 → 调用 → 查余额的自动化流程)。
  4. 一键启动 README 大纲。

验收标准(讲师核验用)

  • 文档覆盖了本模块任务清单的所有要点
  • 你调用的接口字段与 D17 契约文档逐字段一致(没有自创)
  • B 的设计里有明确的幂等方案;A 的设计里有明确的 deduct 调用时机
  • 文档已提交 PR(中文提交信息,如:D17 设计文档:计费引擎(姓名)

参考

  • 课程.md 第 2-6 节
  • 项目接口契约(课程.md 第 3 节,以此为准)
  • 学习网站.md → D17-D21 分组

On this page