SuperAPI AI 工具集

api-patterns

编程与开发

查看项目

更新于 10-15 20:09

技能介绍

用途:为 API 路由提供安全、可校验的实现模式与检查清单,适用于创建新路由、实现 CRUD 端点、添加请求/响应校验、处理 Webhook 及错误处理。所有操作必须使用 RLS 上下文辅助函数。

主要能力:给出权威参考文档位置,包括用户上下文 API(patterns_library/api/user-context-api.md)、管理员上下文(admin-context-api.md)、Zod 校验(zod-validation-api.md)、Webhook 处理(webhook-handler.md)与受保护内容投递(bonus-content-delivery.md)。

禁止模式:绕过 RLS 直接调用 ORM/DB(应使用 withUserContext、withAdminContext 或 withSystemContext);缺少认证检查;未校验用户输入(须用 Zod、Pydantic 等 schema 校验);通用错误响应(须用结构化错误响应)。

检查清单:每个路由须有认证检查、未认证时返回 401、请求 schema 校验、RLS 上下文包装、结构化错误响应与合适状态码、类型安全的请求/响应定义。

响应约定:成功为 {"data":{...},"success":true};错误为 {"error":...,"code":...,"details":...}。状态码 200 成功、201 创建、400 校验错误、401 未认证、403 无权限、404 未找到、500 服务器错误。

用法:技能为模板形式,使用 {{PLACEHOLDER}} 占位符,需替换项目值后套用路由模板,按认证、解析校验、RLS 执行、返回响应的步骤编写,并参考相关技能 rls-patterns、security-audit、testing-patterns。

限制:资料未说明具体技术栈版本、定价或部署要求;占位符必须替换方可使用,未提供完整可直接运行示例的其余细节。