SuperAPI AI 工具集

grey-haven-api-design

编程与开发

查看项目

更新于 10-15 21:55

技能介绍

用途:在 Grey Haven 项目中创建 API 端点、定义模式和处理错误时遵循统一规范,适用于 FastAPI 后端与 TanStack Start 服务函数。

主要能力:RESTful 资源设计(复数小写连字符 URL、层级路径、禁用动词与下划线);HTTP 动词与状态码约定(200/201/204,400/401/403/404/409/422,500/503);多租户隔离(从 JWT 提取 tenant_id 传入仓储,查询自动过滤);FastAPI 路由与 Pydantic 模式(Create/Read/Update,响应不返回密码哈希等敏感字段);TanStack Start 服务函数(createServerFn + zod 校验);统一错误响应格式(error、detail、status_code);分页(offset 与游标两种,大数据集推荐游标);OpenAPI 文档(docstring、summary、description,/docs 与 /redoc);限流(Upstash Redis,默认 100 请求/分钟);CORS(通过 Doppler 读取允许来源,禁止硬编码)。

使用方式:按 examples/、reference/、templates/、checklists/ 中的示例与模板编写端点;测试使用 FastAPI TestClient,命令为 doppler run --config test -- pytest。

适用场景:新建端点、设计资源层级、编写校验模式、实现分页过滤排序、配置错误格式与 OpenAPI、设置限流与 CORS、设计多租户隔离、用 pytest 测试端点、评审 PR 中的 API 设计。

限制:资料未提供具体版本要求、依赖安装命令、收费或价格信息;部分实现细节需参考对应文档文件。