メインコンテンツまでスキップ

Backend SDK

Squid は、アプリケーションの機能性とセキュリティを強化できる Backend SDK を提供しています。この SDK を使うことで、開発者は Typescript で書かれたカスタマイズされたバックエンドコードを定義し、実行できます。​

Squid Backend SDK でできること​

Backend SDK には、あらゆるアプリケーションのニーズに合わせて設計できる幅広い機能があります。以下の機能を活用することで、プロジェクト向けにカスタマイズ可能で柔軟なバックエンドを作成できます。

  • AI agents とチャットする
  • Squid connectors を使って外部リソースに直接接続する
  • リソースアクセスとユーザー認証をセキュアにする
  • Squid のbuilt in database を使ったリアルタイムデータ更新
  • webhook、scheduler、trigger などのカスタマイズ可能なバックエンド関数
  • そのほか多数！

Squid Backend SDK の使い方​

Squid Backend SDK を使用するには、まず Squid の backend project を初期化します。このコマンドは、Squid Console の application overview タブ内にある Backend Project セクションで確認できます。

backend project を初期化したら、バックエンドのカスタマイズを開始できます。バックエンドのカスタマイズの大部分は、SquidService クラスを継承するクラスを作成して行います。このクラスは、アクションを開始したユーザーの認証情報などの有用なコンテキスト情報に加えて、Squid Client への参照である this.squid へのアクセスも提供します。

Tip

backend project を初期化すると、Squid が自動的にバックエンドコードをいくつか生成します。スターターコードの中に、SquidService を継承する ExampleService クラスが含まれています。このファイルは backend project の /src/service ディレクトリにあります。これをバックエンド開発の出発点として利用できます。

this.squid を使用することで、バックエンドコードはクライアントが実行できるあらゆるタスク（クエリの実行やデータの更新など）を実行できます。さらに、クライアントからは禁止されている secrets やリソースにもアクセスできるため、より広い範囲の機能を扱えます。Squid Backend は高いパワーと柔軟性を備えており、アプリケーションに複雑なバックエンド機能を構築する必要がある開発者にとって強力なツールです。

バックエンドのセキュリティ確保

バックエンド project で実行されるコードは、バックエンドリソースに対して無制限にアクセスできる点に注意してください。たとえば、バックエンド project 内で this.squid を使用する場合、認可は不要で、security rules をバイパスします。this.squid は backend project の admin だと考えてください。

バックエンドを安全に保護する方法について詳しくは、[security documentation](/docs/security/authentication/firebase/.

バックエンド機能は、SquidService クラスを継承するクラス（または複数のクラス）内に実装してください。index.ts ファイルがバックエンドコードを Squid server に接続するため、このファイルで追加したクラスを必ず export してください。

次に、コンソールで表示される手順に従って Create a .env file を行い、バックエンドのセットアップを完了してください。Squid CLI を使用してプロジェクトを実行し、ローカルで開発できます。

まとめ​

Squid Backend SDK は、カスタムロジック、セキュリティ、外部リソースとのシームレスな統合を備えたアプリケーションのバックエンドを構築するための、強力で柔軟な手段を提供します。開発者は、シンプルな自動化から、ニーズに合わせてスケールする複雑なワークフローまで構築できます。ご質問やフィードバックがありましたら、contact us までご連絡ください。今すぐ始めて、Squid でバックエンドの可能性を最大限に引き出しましょう！

探索​