Backend SDK
Squid は Backend SDK を提供しており、アプリケーションの機能性とセキュリティを強化できます。SDK を使用すると、開発者は Typescript で記述されたカスタマイズされたバックエンドコードを定義して実行できます。
Squid Backend SDK でできること
Backend SDK には、あらゆるアプリケーションのニーズに合わせて設計できる幅広い機能があります。次の機能を活用することで、プロジェクト向けにカスタマイズ可能で柔軟なバックエンドを作成できます。
- AI agents とチャットする
- Squid connectors を使用して外部リソースに直接接続する
- リソースへのアクセスとユーザー認証を Secure に行う
- Squid の built in database を使用したリアルタイムのデータ更新
- webhook、scheduler、trigger などのカスタマイズ可能なバックエンド関数
- そのほか多数!
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 を使用すると、バックエンドコードはクエリの実行やデータの変更(mutating)など、クライアントが実行できるあらゆるタスクを実行できます。さらに、クライアントからは禁止されている secrets やリソースにもアクセスできるため、より広い範囲の機能を利用できます。Squid Backend は強力な機能と柔軟性を備えており、アプリケーションに複雑なバックエンド機能を構築する必要がある開発者にとって強力なツールとなります。
バックエンドプロジェクトで実行されるコードは、バックエンドリソースに無制限にアクセスできる点に注意してください。たとえば、バックエンドプロジェクト内で this.squid を使用する場合、認可は不要で、security rules はバイパスされます。this.squid はバックエンドプロジェクトの admin として考えてください。
バックエンドを安全に保つ方法について詳しくは、security documentation をお読みください。
バックエンド機能は、SquidService クラスを拡張する 1 つまたは複数のクラス内に構築する必要があります。index.ts ファイルはバックエンドコードを Squid server に接続するため、このファイルで追加したクラスを必ず export してください。
コンソールの次の手順に従って Create a .env file を実行し、バックエンドのセットアップを完了します。Squid CLI を使用してプロジェクトを実行し、ローカルで開発してください。
Conclusion
Squid Backend SDK は、カスタムロジック、セキュリティ、外部リソースとのシームレスな統合によって、アプリケーションのバックエンドを作成するための強力で柔軟な方法を提供します。開発者は、シンプルな自動化からニーズに合わせてスケールする複雑なワークフローまで、あらゆるものを構築できます。ご質問やフィードバックがあれば、ぜひ contact us までご連絡ください。今すぐ始めて、Squid でバックエンドの可能性を最大限に引き出しましょう!
Explore
🗃️ AI機能
7項目
📄️ ローカル開発とCLI
Squid を使ってローカルで開発すると、本番環境にデプロイする前にアプリケーションをテストし、コードに変更を加えることができます。
📄️ Executables(実行可能関数)
サーバーリソースへフルアクセスできるバックエンド関数をクライアントに公開します。
📄️ スケジューラー
定義された時間間隔で関数を実行します。
📄️ Webhooks
外部サービスが呼び出せる HTTP エンドポイントを公開します。
📄️ トリガー
データベースの変更に応じてバックエンド関数を自動的に実行します。
📄️ クライアント接続の管理
バックエンドから、クライアントの接続・切断をリアルタイムに検知して応答します。
📄️ レート制限とクォータ制限
サーバー側のレート制限とクォータ制限で、バックエンド関数を不正利用から保護します。
📄️ OpenAPI仕様を生成する
TypeScriptデコレータを使ってOpenAPI specを自動生成し、REST APIを公開します。
📄️ ファイルからテキストを抽出する
処理のためにファイルからテキストを抽出してドキュメント取り込みを高速化