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 のバージョン互換性表を確認します。