Files
team/tasks/任务提示词模板-后端API开发.md
2026-04-19 21:47:08 +08:00

2.4 KiB
Raw Permalink Blame History

{{任务编号}} 后端任务:{{任务标题}}

概述

{{一段描述:API 目标}}

前置依赖: {{依赖任务列表}}

tmux 执行协议

  • Session: arno-team,始终复用 项目 / 后端 / 前端 / 测试 四个 pane,禁止新建 tmux session / window / pane
  • 环境重置: 开始前确保目标 pane 中是新启动的 cc 环境(/exit 后重启,清除遗留上下文)
  • 分发方式: 由 项目 pane 发送简短提示词,让目标 pane 自行读取任务文件

前置文档(必读)

执行本任务前必须加载以下文档,作为接口和存储规范。

接口与架构规范(所有后端任务通用)

  • docs/09-API契约.md — 完整 REST API 定义(所有后端任务必须严格遵守)
    • §1 通用规范(认证方式)| §2 通用响应格式 | §3 HTTP 状态码 | §4 错误码规范
  • docs/07-系统架构.md §2.2(服务端架构)| §7(模块划分)

数据库规范(所有后端任务通用)

  • docs/08-数据库设计.md §2(服务端数据库)
    • §2.3 索引设计 | §2.5 SQLite DDL 参考
    • §4 数据版本迁移策略(§4.2 迁移脚本规范、§4.3 迁移执行流程)

工程规范(所有后端任务通用)

  • docs/11-工程规范.md §1.5(术语使用规范)| §2(编码规范)| §5(API 设计规范)

按任务选取

任务 API 契约章节 数据库章节
M2-001 §5(设备注册接口)§7(管理接口 §7.1~§7.5) §2.2.1
M5-002 §6(同步接口 §6.1~§6.3 §2.2.2
M8-001 §7.8 GET /api/v1/admin/logs §2.2.3
M8-002 §7.6 POST /api/v1/admin/backups、§7.7 恢复备份 §2.2.4

功能需求(FR-NNN ~ FR-NNN

  • {{需求条目列表}}

需要创建的文件

1. src/{{module_name}}/services/{{service}}.py — {{服务名}}

{{类/方法骨架 + 参数说明 + 约束}}

2. src/{{module_name}}/api/routes/{{route}}.py — API 路由

{{端点定义}}

3. src/{{module_name}}/db/migrations/{{NNNN}}_{{name}}.sql — 数据库迁移

{{DDL}}

编码规范

  • Python 3.12+,完整类型注解(mypy strict
  • ruff format/checkGoogle 风格 docstring
  • 严格遵守 docs/09-API契约.md

验收标准

  • {{逐条检查}}
  • mypy --strict 零错误
  • ruff check 零告警

验证命令

{{具体命令}}

完成后将产出物清单写入 /workspace/tasks/result/{{任务编号}}.md