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

Backend SDK

Squidは、アプリケーションの機能性とセキュリティを向上させるためのBackend SDKを提供しています。このSDKを利用することで、開発者はTypeScriptで記述されたカスタマイズ可能なバックエンドコードを定義および実行できます。​

What can the Squid Backend SDK do?​

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

  • AI agents とチャットする
  • Squid connectors を使用して外部リソースに直接接続
  • Secure によるリソースアクセスとユーザー認証
  • Squidのbuilt in database を用いたリアルタイムデータ更新
  • Webhooks、Schedulers、Triggersなど、カスタマイズ可能なバックエンド機能
  • その他多数!

How to use the Squid Backend SDK​

Squid Backend SDKを使用するには、まずSquidバックエンドプロジェクトを初期化してください。このコマンドは、Squid Consoleのapplication overviewタブ内の Backend Project セクションに記載されています。

バックエンドプロジェクトを初期化した後は、バックエンドのカスタマイズを開始できます。大半のバックエンドのカスタマイズは、SquidService クラスを拡張するクラスを作成することで行います。このクラスは、アクションを開始したユーザーの認証情報などの有用なコンテキスト情報や、Squid Clientへの参照である this.squid へのアクセスを提供します。

ヒント

バックエンドプロジェクトを初期化すると、Squidが自動的にいくつかのバックエンドコードを生成します。スターターコード内には、SquidService を拡張する ExampleService クラスが含まれており、このファイルはバックエンドプロジェクトの /src/service ディレクトリに配置されています。これをバックエンド開発の出発点としてご利用ください。

this.squid を使用することで、バックエンドコードはクライアントが実行できるタスク（クエリの実行やデータの変更など）を実行できます。さらに、クライアントがアクセスできないシークレットやリソースにもアクセス可能なため、より幅広い機能を実現します。Squid Backendはその強力なパワーと柔軟性により、複雑なバックエンド機能を構築する必要がある開発者にとって非常に強力なツールとなります。

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

バックエンドプロジェクトで実行されるコードは、バックエンドリソースに対して無制限のアクセス権を持つ点に注意してください。例えば、バックエンドプロジェクト内での this.squid の使用は認証を必要とせず、セキュリティルールをバイパスします。this.squid をバックエンドプロジェクトの管理者（admin）と考えてください。

バックエンドのセキュリティ強化の方法については、[security documentation](/docs/security/authentication/firebase/ をご参照ください。

バックエンドの機能は、SquidService クラスを拡張する一つまたは複数のクラス内に実装してください。index.ts ファイルはバックエンドコードをSquidサーバーに接続するため、ここで追加したクラスは必ずエクスポートするようにしてください。

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

Conclusion​

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

探索​