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

Backend SDK

Squid は、アプリケーションの機能とセキュリティを強化できる Backend SDK を提供しています。SDK を使用すると、開発者は Typescript で記述したカスタマイズ可能な backend code を定義・実行できます。​

Squid Backend SDK でできること​

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

  • AI agents と chat する
  • Squid connectors を使用して外部 resource に直接接続する
  • resource access と user authentication を保護する
  • Squid の組み込み database を使用してリアルタイムに data を更新する
  • webhooks、schedulers、triggers などのカスタマイズ可能な backend function
  • その他多数

Squid Backend SDK の使用方法​

Squid Backend SDK を使用するには、まず Squid backend project を初期化します。この command は、Squid Console のapplication overview tab にある Backend Project section で確認できます。

backend project を初期化したら、backend のカスタマイズを開始できます。backend のカスタマイズの大部分は、SquidService class を拡張する class を作成して行います。この class は、action を開始した user の authentication detail などの有用な context information と、Squid Client への reference である this.squid への access を提供します。

ヒント

backend project を初期化すると、Squid はいくつかの backend code を自動生成します。starter code には、SquidService を拡張する ExampleService class があります。この file は backend project の /src/service directory にあります。backend development の開始点として利用できます。

this.squid を使用すると、backend code は query の実行や data の mutation など、client が実行できるあらゆる task を実行できます。さらに、client には禁止されている secret と resource に access できるため、より幅広い capability を利用できます。Squid Backend は高い power と flexibility を備えており、アプリケーション向けに複雑な backend functionality を構築する必要がある開発者にとって強力な tool です。

backend の保護

backend project で実行される code は、backend resource へ無制限に access できることに注意してください。たとえば、backend project 内の this.squid の使用には authorization は必要なく、security rule を bypass します。this.squid は backend project の admin として考えてください。

backend を保護する方法について詳しくは、[security documentation](/docs/security/authentication/firebase/.をお読みください。

backend functionality は、SquidService class を拡張する 1 つ以上の class 内に構築する必要があります。index.ts file は backend code を Squid server に接続するため、追加する class は必ずこの file で export してください。

console の次の step に従い、Create a .env file を実行して backend のセットアップを完了します。Squid CLI を使用して project を実行し、ローカルで開発します。

まとめ​

Squid Backend SDK は、custom logic、security、external resource とのシームレスな integration を備えたアプリケーション backend を作成する、強力で柔軟な方法を提供します。開発者は、単純な automation からニーズに応じて scale する複雑な workflow まで構築できます。ご質問や feedback がある場合は、お問い合わせください。今すぐ始めて、Squid で backend の可能性を最大限に引き出しましょう！

探索​