spacetimedb-http

このスキルは、SpacetimeDB の HTTP ルートの動作とリクエストの構築に使用します。

HTTP の基本パターン

• ほとんどの HTTP エンドポイントでは、Authorization: Bearer <token> を指定します。指定しない場合、データベースのエンドポイントは通常、匿名 ID を割り当てるか使用し、パブリックテーブルへのアクセスのみを許可します。
• POST /v1/identity は { "identity": string, "token": string } を返します。
• POST /v1/database/:name_or_identity/call/:reducer は、リデューサーまたはプロシージャを呼び出します。リクエスト本文は引数の JSON 配列です。
• POST /v1/database/:name_or_identity/sql は、; で区切られた 1 つ以上の SQL ステートメントを実行し、schema と rows を含むステートメント結果の JSON を返します。
• GET /v1/database/:name_or_identity/schema?version=... は RawModuleDef の JSON を返し、spacetime describe に対応します。
• GET /v1/database/:name_or_identity/logs にはデータベースの所有権が必要で、spacetime logs に対応します。
• WebSocket サブスクリプションでは、v1.bsatn.spacetimedb または v1.json.spacetimedb サブプロトコルを使用して /v1/database/:name_or_identity/subscribe に接続します。カスタムツールを構築する場合を除き、SDK の使用を推奨します。

リクエスト時の注意事項

• 管理エンドポイントは主にツール、デバッグ、管理用です。通常のアプリケーショントラフィックには SDK の WebSocket クライアントを使用してください。
• 匿名の HTTP リデューサー呼び出しでは、匿名 ID が ReducerContext に渡されます。モジュールの認証ロジックによって拒否される場合があります。
• 匿名ユーザーからの HTTP SQL ではパブリック行のみが表示され、RLS が適用されます。
• 複雑なクエリー文字列を記述する前に、SQL 構文の質問を spacetimedb-sql に回してください。

リファレンスマップ

必要な情報	参照先
認証ヘッダーと ping	references/http-authorization.md
データベースのエンドポイント	references/http-database.md
ID のエンドポイント	references/http-identity.md

ガイダンス

• エンドポイントの例を示す際は、必要なベアラートークンの動作を含めてください。
• SQL 構文に関する質問は spacetimedb-sql に回してください。
• SDK 接続に関する質問は spacetimedb-clients に回してください。