SuperAPI AI 工具集

function-creator

编程与开发

查看项目

更新于 10-15 21:51

技能介绍

用途:在 Convex 后端实现新 API 端点时,生成查询(读取数据)、变更(写入数据)与动作(调用外部 API、长时间运行任务)三类函数,并遵循安全与类型安全最佳实践。

主要能力:三类函数各有边界——查询只读数据库、可缓存响应式、运行于事务中,不能改数据或调外部 API;变更读写数据库、运行于 ACID 事务,冲突时自动重试,不能调外部 API;动作可调用外部 API(如 OpenAI),通过 ctx.runMutation 写库,不能直接访问数据库,且不自动重试。

必要用法:始终用 v 校验器定义 args 与 returns;公开函数中先调用 ctx.auth.getUserIdentity() 检查登录,再校验资源归属与权限;使用索引查询而非 .filter();所有 Promise 均 await;错误信息需具描述性;定时任务等后端专用函数使用 internalMutation 并通过 internal.* 调用。若动作需要 Node.js API(如 crypto、第三方 SDK),在文件顶部加 "use node",且该文件只能包含动作,查询与变更需放在无 "use node" 的独立文件中;只需基础 fetch 时可省略。

适用场景:为 Convex 项目新增读写接口、集成外部服务、编写后端专用任务。限制:资料未提供安装命令、收费与平台等信息。