SuperAPI AI 工具集

payload

编程与开发

查看项目

更新于 10-20 16:16

技能介绍

用途

本技能面向 AI 编码代理,用于在开发 Payload CMS 项目时提供集中参考,覆盖 payload.config.ts、collections、fields、hooks、访问控制与 Payload API 等核心内容,也可用于排查验证错误等问题。

Payload 本身是基于 Next.js 的原生 CMS,采用 TypeScript 优先架构,提供管理后台、数据库管理、REST/GraphQL API、认证与文件存储。

安装方式

资料说明这是 Payload 技能的独立版本。Claude Code 用户优先安装官方 Payload Marketplace 插件(含本技能及 MCP 工具等额外功能);仅在不使用完整插件时才安装本独立技能。其他 AI 代理(Cursor、OpenCode、GitHub Copilot 等)可直接安装:

npx skills add noklip-io/agent-skills --skill payload

快速开始命令:

npx create-payload-app@latest my-app cd my-app pnpm dev

主要能力与参考内容

技能提供快速参考表,将任务映射到解决方案与对应文档章节,包括:自动生成 slug(slugField())、按用户限制内容(带查询的访问控制)、Local API 用户操作(user + overrideAccess: false)、草稿/发布工作流(versions: { drafts: true })、计算字段(virtual: true 配合 afterRead)、条件字段(admin.condition)、自定义字段验证(validate 函数)、关系列表过滤(filterOptions)、字段选择(select 参数)、自动设置作者/日期(beforeChange hook)、防止 hook 循环(req.context 检查)、级联删除(beforeDelete hook)、地理空间查询(point 字段配合 near/within)、反向关系(join 字段)、Next.js 重新验证(afterChange 中的 context 控制)、按关系查询(嵌套属性语法)、复杂查询(AND/OR 逻辑)、事务(向操作传递 req)、后台任务(Jobs 队列与 tasks)、自定义 API 路由(集合自定义端点)、云存储(存储适配器插件)、多语言(localization 配置 + localized: true)、创建插件((options) => (config) => Config)、插件包设置(基于 SWC 的包结构)、向集合添加字段、插件 hooks、检查字段类型(类型守卫函数)。

文中还给出最小配置示例(buildConfig、mongooseAdapter、lexicalEditor、typescript 输出等)、基础集合定义(Posts)、常用字段写法(text、relationship、richText、select、upload)、beforeChange hook 示例、类型安全访问控制(adminOnly、ownPostsOnly)与 Local API 查询示例(where、depth、limit、sort),以及获取 Payload 实例的方式(API 路由与 Server Components 中使用 getPayload)。项目结构示例包含 app、collections、globals、components、hooks 与 payload.config.ts。类型生成通过 typescript.outputFile 配置并导入 payload-types。

安全注意事项

  1. Local API 访问控制:默认情况下 Local API 操作会绕过所有访问控制,即使传入 user;需在代表用户操作时设置 overrideAccess: false。
  2. Hook 中的事务失败:hooks 内嵌套操作若未传递 req 会破坏事务原子性,应传入 req。
  3. 无限 Hook 循环:hook 触发会再次触发同一 hook 的操作会形成死循环,应使用 context 标志跳过。

参考文档索引

FIELDS.md、FIELD-TYPE-GUARDS.md、COLLECTIONS.md、HOOKS.md、ACCESS-CONTROL.md、ACCESS-CONTROL-ADVANCED.md、QUERIES.md、ENDPOINTS.md、ADAPTERS.md、ADVANCED.md、PLUGIN-DEVELOPMENT.md。

资源链接

llms-full.txt:https://payloadcms.com/llms-full.txt;文档:https://payloadcms.com/docs;GitHub:https://github.com/payloadcms/payload;示例:https://github.com/payloadcms/payload/tree/main/examples;模板:https://github.com/payloadcms/payload/tree/main/templates。

限制

资料未提供该技能的收费、价格、支持平台范围或性能效果等信息,暂未提供。