バックエンドブロックは、再利用可能なバックエンドドメインのSDKリファレンスです。統合ガイドが必要なドメインを選択し、そのフィーチャ、スキーマ、ルート、バリデーターへのリンクをたどって、必要な正確な契約書を確認してください。カタログはこのディレクトリ内のすべての現在のフォルダを反映しています。
まずはここから
完成したHTTP統合を開始するには、ドメインのindex.mdページとそのサービス設定から始めてください。カスタム統合の場合は、features.mdページから始めてください:フィーチャはリクエストスキーマとルートcomposerを合成し、サービスは通常の水 datastore、設定、認証、オプションのドライバーコンテキストを提供します。
すべてのドメインがサービスであるわけではありません。Common、Mongo、Avatar、File Storageは再利用可能なビルドブロックのリファレンスです。OAuthとInvitationは、独立したサービスとしてマウントするのではなくauthServiceによって合成されます。
責任で閲覧
基盤と共有契約
| ドメイン | 用途 | 利用可能なリファレンスページ |
|---|
| 🔄 Common | クロスドメイン正規化、レスポンスヘルパー、スキーマ、バリデーター | ブロック、スキーマ、バリデーター |
| 🗄️ Mongo | カスタムまたはドメインパイプライン用のMongoDBクエリブロックと射影 | ブロック |
| 📁 File Storage | 署名付きアップロード/ダウンロード/削除URLとファイル正規化 | ブロック、スキーマ |
| 🖼️ Avatar | 保存されたアバター参照、署名付きレスポンスURL、置き換えクリーンアップ | ブロック、スキーマ |
アイデンティティ、アクセス、ユーザー向け状態
| ドメイン | 用途 | 利用可能なリファレンスページ |
|---|
| 🔐 Authentication | 資格情報、トークン、MFA、メール確認、アカウントライフサイクル | ブロック、フィーチャ、ハンドラ、ルート、スキーマ、バリデーター |
| 🆔 Identity | 管理者アイデンティティ管理とアイデンティティ検索契約 | ブロック、フィーチャ、ルート、スキーマ、バリデーター |
| 🔗 OAuth | authServiceによって合成されるGoogle、LINE、TwitterブラウザOAuthフロー | ブロック、フィーチャ、ルート、スキーマ |
| 📧 Invitation | authServiceによって合成される管理者招待フロー | フィーチャ、ハンドラ、ルート、スキーマ |
| 👥 Profile | プロフィール、アバター、フォロー、組織フォロー、製品いいね | ブロック、フィーチャ、ハンドラ、ルート、スキーマ、バリデーター |
| 🔔 Notification | レシーバースコープの通知一覧と既読操作 | ブロック、フィーチャ、ルート、スキーマ、バリデーター |
アプリケーションドメイン
| ドメイン | 用途 | 利用可能なリファレンスページ |
|---|
| 🏠 Address | ホスト提供のドライバーによる認証済み日本郵便番号検索 | ブロック、フィーチャ、ルート、スキーマ、バリデーター |
| 🏷️ Attribute | 文字列キーバリューアイテムの名前付きグループ | フィーチャ、ハンドラ、ルート、スキーマ、バリデーター |
| 📂 Category | パブリックカテゴリ参照と管理者カテゴリ管理 | フィーチャ、ハンドラ、ルート、スキーマ、バリデーター |
| 💬 Chat | HTTPとWebSocketチャンネル、メッセージ、添付ファイル、テンプレート、購読、既読状態 | ブロック、フィーチャ、ハンドラ、ルート、スキーマ、バリデーター |
| 📍 Location | 階層的な場所参照と管理者管理 | ブロック、フィーチャ、ルート、スキーマ、バリデーター |
| 🛒 Order | 認証済みライフサイクルと組織スコープ注文一覧 | ブロック、フィーチャ、ハンドラ、ルート、スキーマ、バリデーター |
| 🏢 Organization | 組織、メンバーシップ、階層、変更リクエスト、アップロード、フォロワー | ブロック、フィーチャ、ハンドラ、ルート、スキーマ、バリデーター |
| 🛍️ Product | 商品一覧、商品とバリエーション管理、画像、組織、いいね | ブロック、フィーチャ、ハンドラ、ルート、スキーマ、バリデーター |
リファレンスページの関係
| ページ | ドキュメント内容 | 使用タイミング |
|---|
index.md | サービスまたは統合の設定、依存関係、共通ワークフロー、ドメインリファレンスへのリンク | ドメインのマウントまたは選択時にここから始める |
blocks.md | 再利用可能な操作、結果/エラー型、定数、ヘルパー | カスタムパイプラインで動作を再利用 |
schemas.md | 保存された形状とリクエスト検証契約 | 有効なリクエストを構築するか、フィールドを理解するために使用 |
handlers.md | ルートパイプライン操作とターミネーター | 既存のパイプライン動作を理解または再利用 |
routes.md | パブリックルートcomposer、HTTPメソッド、パス、アクセスルール、ステータス、完全なソース | エンドポイントの動作を確認 |
features.md | スキーマからルートへのcomposer | 選択したエンドポイント機能を構成 |
validators.md | 認証、認可、ドメイン検証の合成 | アクセス制御と検証順序を理解 |
ドメインは、そのレイヤーに該当するパブリックエクスポートがない場合、ページを省略します。Reference mapを使用して、その正確なページのセットを確認してください。
統合パスを選択