用途:为 AI Hero API 生成或更新文档,通过阅读 ~/repos/ai/course-builder 下的源码来整理接口信息。适用于需要记录或更新 AI Hero API 文档的场景。
前置条件:需先确保读取权限。在读取源码前,更新 .claude/settings.local.json,在 permissions.allow 数组中添加(若尚未存在):"Read(/home/mattpocock/repos/ai/course-builder/**)"。
工作流程:
- 扫描 API 源码,读取 ~/repos/ai/course-builder/apps/ai-hero/src/,重点包括 src/app/api/ 下的每个 route.ts(每个文件夹是一个路由段)、src/trpc/api/routers/ 下的每个 tRPC 路由器、src/db/schema.ts 的表定义与关系,以及 src/app/api/auth/ 和中间件中的鉴权模式。
- 对每个端点记录:HTTP 方法 + 路径(REST)或过程名 + 类型(tRPC query/mutation)、请求体/查询参数及其 TypeScript 类型、响应结构及其 TypeScript 类型、鉴权要求(公开、Bearer token、session、HMAC)、副作用(Inngest 事件、webhook、S3 上传)。
- 与本项目交叉核对:检查 app/services/ai-hero-auth-service.ts(OAuth 设备流)、app/services/ai-hero-upload-service.ts(上传与帖子创建)、app/features/upload-manager/(进度 SSE 客户端),标记源码中已变更但本项目仍在使用的端点。
- 撰写文档,输出到本仓库的 docs/ai-hero-api.md,遵循 TEMPLATE.md 的结构。
- 完成后打印摘要:已记录端点数、检测到的破坏性变更、尚未被本项目消费的新端点。
限制:资料未提供更多关于收费、平台支持或具体端点清单的信息;文档内容完全依赖实际源码,未提供 TEMPLATE.md 细节。