跳到主要内容

快速入门

本指南将引导你逐步了解并开始使用 @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 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'; // 或完整的 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();

响应示例

如果调用成功,你将收到一个类似这样的响应对象:

Response

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

后续步骤

恭喜!你已成功安装 Blocklet Server 客户端并完成了你的第一次 API 调用。

大多数 API 调用都需要身份验证,以确保只有授权的用户或应用程序才能访问或修改数据。下一步是学习如何对你的请求进行身份验证。

身份验证

继续阅读身份验证指南,了解如何使用认证令牌和访问密钥来保护你的 API 调用。

了解身份验证