SuperAPI AI 工具集

repo-website-api-create

编程与开发

查看项目

更新于 10-16 02:39

技能介绍

用途:为 Valibot 官网 website/src/routes/api/ 目录创建新的 API 参考页面,适用于新增 schema、action、method 或 type 的文档。

主要能力与流程:

  1. 阅读 /library/src/ 下的源码,提取 Issue 接口、Schema/Action 接口、函数重载与 JSDoc(JSDoc 中的 Hint 会以引用块形式出现在 Explanation 段落)。
  2. 在 /website/src/routes/api/(category)/[name]/ 下建立目录,分类包括 (schemas)、(actions)、(methods)、(types)、(utils)、(async)、(storages);创建 properties.ts 存放类型定义,index.mdx 存放文档正文。
  3. properties.ts 使用 PropertyProps 记录泛型(modifier 为 'extends')、参数与返回类型;可选对象键不写 ?,而是在联合类型末尾加 'undefined'。类型语法支持 primitive、literal、custom、union、intersect、array、tuple、object、function、template 等。
  4. index.mdx 使用 frontmatter(title、description、source、contributors),配合 Property 与 ApiList 组件;函数页包含 Generics、Parameters、Explanation、Returns、Examples、Related 段落,Related 顺序为 Schemas → Methods → Actions → Utils,空段落省略。
  5. 更新 menu.md,按字母序加入条目;为新 API 更新其他 API 页的 Related 段落,并更新对应概念指南(schemas、pipelines、methods)。
  6. 必要时新建类型页:无 source 字段,无 Examples 与 Related,使用 ## Definition 而非 ## Returns。

约定:Schema 变量用 PascalCase + Schema 后缀,Action 变量用 PascalCase + Action;示例应包含具体错误信息并逐步由简到繁;类型引用统一用 href: '../TypeName/'(带尾斜杠);正文内链接可用 /api/parse/ 形式。

限制与检查:需逐项完成检查清单,确保源码读取完整、properties.ts 与源码类型一致、签名与泛型参数匹配、menu.md 已按字母序更新、关联 API 与概念指南已同步、所有 href 链接有效。官方仓库未提供的额外收费、平台或效果信息暂未提供。