@blocklet/server-jsの完全なAPIリファレンスへようこそ。このセクションでは、Blocklet Server Clientを通じて利用可能なすべてのGraphQLクエリ、ミューテーション、およびタイプの詳細なドキュメントを提供します。データの取得、サーバー状態の変更、または扱っているデータの構造を理解する必要がある場合でも、これはあなたのための包括的なガイドです。
APIは主に3つのカテゴリに分かれています：
クエリ
クエリを使用してBlocklet Serverからデータを取得します。これには、Blocklet、ユーザー、ロール、システムステータスに関する情報の取得が含まれます。
ミューテーション
ミューテーションを使用してBlocklet Server上のデータを作成、更新、または削除します。これには、Blockletのインストール、ユーザー管理、設定の更新などのアクションが含まれます。
タイプ
API全体で使用されるデータ構造を理解します。このセクションでは、すべての入力オブジェクト、列挙型、および応答タイプについて詳しく説明します。
クエリ
クエリはBlocklet Serverからデータを読み取るか、取得するために使用されます。Blocklet Server Clientは、これらのGraphQLクエリをラップする便利なメソッドセットを提供しており、生のGraphQLを記述することなく簡単に情報を取得できます。これらのメソッドは、ノードのステータスの確認から詳細なユーザー情報の取得まで、幅広い機能をカバーしています。
利用可能なすべてのクエリメソッドとその詳細なドキュメントの完全なリストについては、クエリセクションをご覧ください。
ミューテーション
ミューテーションは、サーバー側のデータを変更するために使用されます。これには、リソースの作成、更新、削除などのアクションが含まれます。Blocklet Server Clientは、Blocklet、ユーザー、およびその他のサーバーリソースのライフサイクル全体をプログラムで管理できる包括的なミューテーションメソッドのセットを提供します。
利用可能なすべてのミューテーションメソッドとその詳細なドキュメントの完全なリストについては、ミューテーションセクションをご覧ください。
タイプ
タイプは、クエリおよび送信できるデータの構造を定義します。これには、オブジェクトタイプ、入力タイプ、および列挙型が含まれます。これらのタイプを理解することは、リクエストとレスポンスの両方でデータの形状を決定するため、APIを効果的に使用するために不可欠です。
APIで使用されるすべてのデータタイプの完全なリファレンスについては、タイプセクションをご覧ください。