enonic-api-reference

Enonic XP 服务端 API 参考

操作流程

步骤 1：确定目标库

1. 确定查询涉及哪个 /lib/xp/* 库。

2. 将该库对应到适当的参考文件：

   库	参考文件
   lib-content	references/lib-content-reference.md
   lib-node	references/lib-node-reference.md
   lib-auth	references/lib-auth-reference.md
   lib-portal	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

3. 如果查询涉及多个库或询问用法模式，请阅读 references/examples.md。

步骤 2：查找函数

1. 阅读已确定的参考文件。
2. 按名称查找具体函数。
3. 提取以下详细信息：
   • 签名： 函数名称和导入路径。
   • 参数： 名称、类型、必填/可选、默认值、说明。
   • 返回类型： 返回值的类型和结构。
   • 示例： 展示正确用法的代码片段。

步骤 3：提供答案

1. 提供函数签名及其导入语句。
2. 附上包含类型和说明的参数表。
3. 附上返回类型及其结构。
4. 添加用法示例。如果参考文件中包含示例，请使用该示例；否则，请根据文档中的签名编写一个最简可运行示例。
5. 注明任何版本要求（例如，“需要 XP 7.8.0+”）。

步骤 4：处理跨库模式

1. 如果查询涉及组合使用多个库（例如“以管理员身份创建内容”），请阅读 references/examples.md，了解已有模式。
2. 如果文档中没有该模式，请结合相关参考文件中的各个函数签名编写。

步骤 5：排查常见问题

1. 如果查询描述了错误或意外行为，请阅读 references/troubleshooting.md。
2. 将错误消息或症状与已知问题匹配。
3. 提供文档记录的修复方法以及任何版本兼容性说明。

步骤 6：生成导入代码块

1. 如果用户需要可重复使用的导入代码块，请阅读 assets/enonic-imports.template.ts。
2. 仅取消注释用户控制器所需的库。

错误处理

• 如果在任何参考文件中都找不到某个函数，请说明它可能属于社区库，或属于尚未记录的新版本 XP，并建议查看 https://developer.enonic.com/docs/xp/stable/api。
• 如果查询涉及 Guillotine/GraphQL、内容类型架构或 Enonic CLI，请说明此技能不涵盖这些主题。
• 如果怀疑存在版本不匹配，请查阅 references/troubleshooting.md 中的版本兼容性表。