SuperAPI AI 工具集

project-guidelines-example

通用与其它

查看项目

更新于 10-16 04:53

技能介绍

用途:这是一个项目特定技能(Skill)的示例模板,基于真实生产应用 Zenith(AI 驱动的客户挖掘平台)编写,供用户为自己的项目创建同类技能文档时参考。

主要内容:文档涵盖架构概览、文件结构、代码模式、测试要求、部署工作流五个部分。架构上采用 Next.js 15(App Router)+ TypeScript 前端、FastAPI(Python 3.11)+ Pydantic 后端、Supabase(PostgreSQL)数据库、Claude API(支持工具调用与结构化输出)以及 Redis 缓存,部署于 Google Cloud Run。文件结构区分 frontend 与 backend 目录,并列出 app、components、hooks、lib、types、routers、services、tests 等子目录用途。

代码模式:给出 FastAPI 的 ApiResponse 泛型响应格式、前端 TypeScript 的 fetchApi 封装、Claude 结构化输出集成(通过 tool_choice 强制工具调用并解析 tool_use 结果)、以及 React 自定义 useApi Hook 的写法。

测试与部署:后端使用 pytest(含覆盖率与异步测试示例),前端使用 React Testing Library 与 Playwright E2E;部署前需通过本地测试、构建与密钥检查,部署命令为 gcloud run deploy。文档还列出前后端环境变量示例与关键规则(如禁止 emoji、不可变性、TDD、最低 80% 覆盖率、单文件行数限制、禁止 console.log、错误处理与输入验证)。

限制:该资料为模板示例,具体项目需自行替换架构、命令与配置;未提供安装步骤、收费信息或平台支持范围。