bitrix-rest について
Bitrix モジュール開発者向けの REST サーバー構築スキルです。登録方法、アクセス確認、エラー処理を扱い、新しい API には REST 3.0 を推奨しつつ、従来のメソッドやコントローラーも説明します。
主な機能
- 01モジュールの REST メソッド公開
- 02REST 3.0 API の登録
- 03Engine コントローラーの設定
- 04従来型メソッドマップの定義
- 05各アクションでの権限確認
- 06REST 形式でのエラー返却
活用シーン
- 01モジュールの REST API 化
- 02REST イベントや placements の実装
- 03アプリ向け権限スコープの維持
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/bitrix-restを入力して読み込まれたか確認します。
同梱ファイルrules/classic.mdrules/v3.md
詳細
REST サーバー側（rest）
ベースライン：main 23.0+ · 検証済み：rest 26.650.0、main 26.800.0
モジュールからメソッドを公開します。REST の呼び出し（Webhook、OAuth、バッチ処理、制限、クライアント側のエラーハンドリング）：bitrix24-rest-api。
| パス | 登録方法 | 参照先 |
|---|---|---|
REST 3.0（/rest/api/…、DTO、JSON） | モジュールの .settings.php → rest セクション | rules/v3.md |
| Engine コントローラー（AJAX と同じクラス） | .settings.php → controllers.restIntegration.enabled | rules/classic.md |
| 従来のメソッドマップ、REST イベント、プレースメント | イベント rest:OnRestServiceBuildDescription | rules/classic.md |
新しい API には、REST 3.0（rest 26.200* 以降）を使用します。フォールバックとして、Engine コントローラーと restIntegration を使用します。REST イベント、プレースメント、または明示的なメソッド名には、従来の記述を使用します。
不変条件
Loader::includeModule('rest')を実行します。コードは/local/modules/<vendor.module>/に配置し、モジュールをインストールしておく必要があります。- REST 呼び出しでは CSRF を使用しません。認証にはアプリのトークンまたは Webhook を使用します。各アクション内でユーザーの権限を確認してください。
- スコープはアプリに付与する権限の単位です。名前を安定させ、文書化してください。
- エラーは REST 形式（v3 の例外、コントローラーの
addError、\Bitrix\Rest\RestException）で返してください。HTML やdie()は使用しないでください。 restクラスを継承したり、Bitrix\Rest\Internal\*のコントラクトを実装したりしないでください。マイナーリリースでシグネチャが変更されます（26.650：Engine\Access、Api\User、IncomingWebhookRepositoryInterface）。代わりにコンポジションを使用してください。- REST 経由のランディングブロックとプレースメントについては、
bitrix-landingを参照してください。
コメント
Markdown 対応