メインコンテンツへスキップ

はじめに

このガイドでは、@blocklet/server-js ライブラリを使い始めるためのステップバイステップのウォークスルーを提供します。クライアントのインストール方法、Blocklet Server への接続方法、そして最初の API コールを行う方法を学びます。

このガイドでは、@blocklet/server-js ライブラリを使い始めるためのステップバイステップのウォークスルーを提供します。クライアントのインストール方法、Blocklet Server への接続方法、そして最初の API コールを行う方法を学びます。

インストール

まず、@blocklet/server-js パッケージをプロジェクトに追加する必要があります。お好みのパッケージマネージャーを使用できます。

npm

bash
npm install @blocklet/server-js

yarn

bash
yarn add @blocklet/server-js

pnpm

bash
pnpm add @blocklet/server-js

使用方法

このライブラリは、Node.js とブラウザの両方の環境でシームレスに動作するように設計されています。最初のステップは、Blocklet Server の GraphQL エンドポイントを使用して BlockletServerClient をインポートし、インスタンス化することです。

Node.js

Node.js 環境では、require または import を使用してクライアントクラスを取得できます。

Node.js Example

javascript
const BlockletServerClient = require('@blocklet/server-js');

// お使いの Blocklet Server の GraphQL エンドポイントに置き換えてください
const endpoint = 'http://localhost:4000/api';
const client = new BlockletServerClient(endpoint);

ブラウザ

フロントエンドアプリケーションの場合、クライアントをコンポーネントやスクリプトに直接インポートできます。

Browser Example

javascript
import BlockletServerClient from '@blocklet/server-js';

// エンドポイントは通常、フロントエンドが提供される場所のものです
const endpoint = '/api'; // または 'https://my-node.abtnode.com/api' のような完全な URL
const client = new BlockletServerClient(endpoint);

最初の API コールを行う

クライアントが初期化されると、そのメソッドを使用して Blocklet Server の GraphQL API と対話できます。ノードに関する基本情報を取得するための簡単なクエリを実行してみましょう。

すべての API メソッドは、response または error のいずれかを含むオブジェクトを返します。

fetch-node-info.js

javascript
const BlockletServerClient = require('@blocklet/server-js');

async function fetchNodeInfo() {
  try {
    // お使いの Blocklet Server の GraphQL エンドポイントに置き換えてください
    const client = new BlockletServerClient('http://localhost:4000/api');

    // ノードの情報を取得する
    const { response, error } = await client.getNodeInfo();

    if (error) {
      console.error('Error fetching node info:', error.message);
      return;
    }

    console.log('Node Info:', response.info);
  } catch (err) {
    console.error('An unexpected error occurred:', err);
  }
}

fetchNodeInfo();

レスポンスの例

コールが成功すると、次のようなレスポンスオブジェクトを受け取ります。

Response

json
{
  "info": {
    "name": "My Development Node",
    "version": "1.16.22",
    "did": "z8iZge7d3iYy2iZb..."
  }
}

次のステップ

おめでとうございます!Blocklet Server Client のインストールと最初の API コールの実行に成功しました。

ほとんどの API コールでは、認証されたユーザーやアプリケーションのみがデータにアクセスしたり変更したりできるように、認証が必要です。次のステップは、リクエストを認証する方法を学ぶことです。

認証

認証ガイドに進み、認証トークンとアクセスキーを使用して API コールを保護する方法を理解してください。

認証について学ぶ