跳到主要內容

入門指南

本指南提供逐步教學,引導您快速上手並執行 @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 環境中,您可以使用 requireimport 來取得客戶端類別。

Node.js 範例

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

// 請替換為您的 Blocklet Server 的 GraphQL 端點
const endpoint = 'http://localhost:4000/api';
const client = new BlockletServerClient(endpoint);

瀏覽器

對於前端應用程式,您可以直接將客戶端匯入您的元件或腳本中。

瀏覽器範例

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

// 端點通常是您的前端應用程式所服務的端點
const endpoint = '/api'; // 或是一個完整的 URL,例如 'https://my-node.abtnode.com/api'
const client = new BlockletServerClient(endpoint);

進行您的第一次 API 呼叫

客戶端初始化後,您可以使用其方法與 Blocklet Server 的 GraphQL API 進行互動。讓我們進行一個簡單的查詢來獲取有關節點的基本資訊。

所有 API 方法都會返回一個包含 responseerror 的物件。

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();

範例回應

如果呼叫成功,您將收到類似以下的回應物件:

回應

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

後續步驟

恭喜!您已成功安裝 Blocklet Server Client 並進行了您的第一次 API 呼叫。

大多數 API 呼叫都需要驗證,以確保只有授權的使用者或應用程式可以存取或修改資料。下一步是學習如何驗證您的請求。

驗證

前往驗證指南,了解如何使用認證權杖和存取金鑰來保護您的 API 呼叫安全。

了解驗證