SuperAPI AI 工具集

enonic-api-reference

编程与开发

查看项目

更新于 10-15 23:57

技能介绍

用途:为 Enonic XP 服务端 JavaScript/TypeScript 开发提供 /lib/xp/* 库的 API 参考查询,帮助定位函数签名、参数、返回类型与用法示例。

主要能力:按目标库映射到对应参考文件,如 lib-content、lib-node、lib-auth、lib-portal 分别对应 references/lib-content-reference.md、references/lib-node-reference.md、references/lib-auth-reference.md、references/lib-portal-reference.md;lib-context、lib-event、lib-task 对应 references/lib-context-reference.md;lib-io、lib-mail、lib-repo、lib-schema 对应 references/lib-utilities-reference.md。跨库或用法模式查询读取 references/examples.md,错误排查读取 references/troubleshooting.md,生成可复用导入块读取 assets/enonic-imports.template.ts。

使用方式:先确定查询涉及的库并读取对应参考文件,按函数名查找并提取签名、参数(名称、类型、必填/可选、默认值、说明)、返回类型与示例;回答时给出函数签名与导入语句、参数表、返回类型及用法示例,并注明版本要求(如 Requires XP 7.8.0+)。跨库模式可组合各参考文件中的函数签名;未记录的则自行组合。

适用场景:Enonic XP 服务端开发中查询 /lib/xp/* API、组合多库调用模式、排查常见错误、生成控制器导入块。

限制:不覆盖 Guillotine/GraphQL、内容类型 schema 与 Enonic CLI;若函数未在参考文件中找到,可能属于社区库或尚未记录的新版 XP,建议查阅 https://developer.enonic.com/docs/xp/stable/api;版本不匹配时参考 troubleshooting.md 中的版本兼容表。