SuperAPI AI 工具集

fullstack-workflow

编程与开发

查看项目

更新于 10-15 21:37

技能介绍

用途:这是一套在 Inbox Zero 代码库中从 API 到 UI 构建新功能的完整开发流程,用于需要同时处理数据读取与写入(创建/更新/删除)的全栈功能。

主要能力与约定:

  • GET API 路由用于取数,必须用 withAuth 或 withEmailAccount 包裹,并导出响应类型供客户端使用。
  • 变更操作使用 Server Action,基于 next-safe-action,配合 Zod 校验。按场景选择 actionClientUser、actionClient 或 adminActionClient,并用 .metadata({ name: "actionName" }) 支持 Sentry 埋点,预期错误用 SafeError。
  • 客户端取数使用 SWR,钩子可复用 GET 路由导出的类型。
  • 表单使用 React Hook Form + zodResolver,提交通过 next-safe-action/hooks 的 useAction 执行,onSuccess/onError 回调配合 getActionErrorMessage 处理错误。
  • 加载与错误状态统一使用 LoadingContent 组件;变更成功后调用 mutate() 刷新数据。

使用方式:按文件组织约定放置代码,例如 app/api/user/example/route.ts 放 GET 路由,utils/actions/example.validation.ts 放 Zod schema,utils/actions/example.ts 放 Server Action,hooks/useExamples.ts 放 SWR 钩子,components/ExampleForm.tsx 放表单组件。

限制与注意:资料明确要求所有变更使用 Server Action,不要用 POST API 路由做变更;使用中间件时 GET 路由无需 try/catch。具体依赖版本、安装命令及完整配置资料未提供。