@ 持续- labs/ sdk

连续 API 的 SDK 类型.

Spekeasy从公共连续API合同中生成了这个SDK. 这个 API 参考 记录每个操作。 在此寄存器中报告 SDK 和 API 的问题 .

内容提要

连续API:从快照开始API Boxs,Web Boxs和MCP Boxs. 以 API 密钥认证作为 Bearer 令牌发送的每项请求 .

目录

• @ 持续- labs/ sdk
  • SDK 安装
  • 所需资源
  • SDK 示例使用法
  • 认证
  • 现有资源和业务
  • 独立职能
  • 倾斜
  • 文件上传
  • 检索
  • 处理错误
  • 服务器选择
  • 自定义 HTTP 客户端
  • 调试
• 发展
  • 成熟度
  • 捐款

SDK 安装

SDK可以安装其中之一 无, (中文(简体) ), 小时, (中文(简体) ), 包头 或者说 线条 软件包管理器.

国家预防机制

npm add @continuous-labs/sdk

菲律宾

pnpm add @continuous-labs/sdk

阿宝

bun add @continuous-labs/sdk

雅伦

yarn add @continuous-labs/sdk

[注] 此软件包仅作为ES模块(ESM)发布. 用于应用 常见JS, 使用 await import("@continuous-labs/sdk") 以导入和使用此软件包.

所需资源

对于支持的 JavaScript 运行时间, 请参考 运行时间.md。 。 。 .

SDK 示例使用法

示例

import { Continuous } from "@continuous-labs/sdk";

const continuous = new Continuous({
  apiKeyAuth: process.env["CONTINUOUS_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await continuous.apibox.listApiboxes({});

  for await (const page of result) {
    console.log(page);
  }
}

run();

认证

常客安全计划

这个SDK在全球支持以下安全计划:

用 API 认证 apiKeyAuth 初始化 SDK 客户端实例时必须设置参数 。 例如:

import { Continuous } from "@continuous-labs/sdk";

const continuous = new Continuous({
  apiKeyAuth: process.env["CONTINUOUS_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await continuous.apibox.listApiboxes({});

  for await (const page of result) {
    console.log(page);
  }
}

run();

现有资源和业务

独立职能

上述所有方法都作为独立功能提供。 这些 函数是用于在浏览器中运行的应用程序的理想功能,没有服务器 运行时间或应用程序捆绑大小为主的其他环境 关心。 当使用捆绑器构建您的应用程序时, 全部未使用 功能将被从最后的捆绑中排除,或者被树切除.

要了解更多独立函数, 请检查 职能.md。 。 。 .

倾斜

此 SDK 中的一些端点支持 pagination. 要用帕吉恩语,你 使您的 SDK 调用如常, 但返回的响应对象也将是 可使用下列设备消耗的同步可执行性: for await...of 语法.

举个例子说

import { Continuous } from "@continuous-labs/sdk";

const continuous = new Continuous({
  apiKeyAuth: process.env["CONTINUOUS_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await continuous.apibox.listApiboxes({});

  for await (const page of result) {
    console.log(page);
  }
}

run();

文件上传

某些SDK方法接受文件作为多段请求的一部分. 可以而且通常建议将文件作为流上传,而不是将全部内容读入内存. 这避免了过度的内存消耗,并且在与非常大的文件合作时,可能会与外出错误相撞. 以下示例说明如何在请求中附加文件流 .

[TIP]

根据您的 JavaScript 运行时间, 有一些方便的功能可以将一个控件返回到一个文件, 而不将全部内容读入内存 :

• 节点.js v20+: V20年以后,Node.js有一个本地人 openAsBlob 函数在 node:fs。 。 。 .
• 宾: 当地人 Bun.file 函数生成一个可用于流文件上传的文件手柄.
• 浏览器 : 所有支持的浏览器返回实例到一个 File 当从一个值读取时 <input type="file"> 键.
• 节点.js v18: 文件流可以使用 fileFrom 助手从 fetch-blob/from.js。 。 。 .

import { Continuous } from "@continuous-labs/sdk";

const continuous = new Continuous({
  apiKeyAuth: process.env["CONTINUOUS_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await continuous.apiboxSnapshots.createApiboxSnapshot({
    body: {
      request: {},
    },
  });

  console.log(result);
}

run();

检索

此 SDK 中的一些端点支持重试. 如果在没有任何配置的情况下使用SDK,则会回落到API提供的默认重试策略. 然而,默认的重试策略可以在一次操作的基础上被推翻,或者在整个SDK中被推翻.

更改单个 API 调用默认重试策略, 只需为调用提供重试 Config 对象 :

import { Continuous } from "@continuous-labs/sdk";

const continuous = new Continuous({
  apiKeyAuth: process.env["CONTINUOUS_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await continuous.apibox.listApiboxes({}, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

如果您想要覆盖所有支持重试的操作的默认重试策略, 您可以在 SDK 初始化时提供重试Config :

import { Continuous } from "@continuous-labs/sdk";

const continuous = new Continuous({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKeyAuth: process.env["CONTINUOUS_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await continuous.apibox.listApiboxes({});

  for await (const page of result) {
    console.log(page);
  }
}

run();

处理错误

ContinuousError 是所有 HTTP 错误响应的基础类。 其属性如下:

示例

import { Continuous } from "@continuous-labs/sdk";
import * as errors from "@continuous-labs/sdk/models/errors";

const continuous = new Continuous({
  apiKeyAuth: process.env["CONTINUOUS_API_KEY_AUTH"] ?? "",
});

async function run() {
  try {
    const result = await continuous.apibox.listApiboxes({});

    for await (const page of result) {
      console.log(page);
    }
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.ContinuousError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorT) {
        console.log(error.data$.code); // string
        console.log(error.data$.detail); // string
        console.log(error.data$.validation); // models.SpecificationValidation
      }
    }
  }
}

run();

错误分类

主错误 :

• ContinuousError: HTTP 错误响应的基础类.
  • ErrorT: 通用错误.

* 检查 方法文档 以查看该错误是否适用.

服务器选择

覆盖服务器 URL / 客户端

通过将 URL 传递到 serverURL: string 初始化 SDK 客户端实例时的可选参数 。 例如:

import { Continuous } from "@continuous-labs/sdk";

const continuous = new Continuous({
  serverURL: "https://api.continuouslabs.ai",
  apiKeyAuth: process.env["CONTINUOUS_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await continuous.apibox.listApiboxes({});

  for await (const page of result) {
    console.log(page);
  }
}

run();

自定义 HTTP 客户端

TypeScript SDK 使用一个 HTTPClient 将本地人包裹起来 获取 API这个 客户端是薄薄的包装 fetch 并且提供连接钩子的能力 围绕可用于修改请求或处理的请求生命周期 错误和反应.

这个 HTTPClient 构造器使用可选 fetcher 参数可以是 用于整合第三方 HTTP 客户端或用于编写测试以嘲弄 hTTP 客户端并输入固定设备.

以下例子说明如何:

• 通过使用 未编辑代理代理代理服务器
• 使用该 "beforeRequest" 向请求添加自定义头和超时
• 使用该 "requestError" 记录错误的钩头

import { Continuous } from "@continuous-labs/sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@continuous-labs/sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Continuous({ httpClient: httpClient });

调试

您可以为 SDK 请求和响应设置 SDK 以发送调试日志 .

你可以通过一个匹配的日志 console'作为 SDK 选项的接口.

[尖叫声] 注意调试日志会揭示一些秘密, 如标题中的 API 令牌, 打印到控制台或文件中的日志信息 。 建议只在本地开发期间使用这一特征,而不能用于生产.

import { Continuous } from "@continuous-labs/sdk";

const sdk = new Continuous({ debugLogger: console });

通过设置环境变量也可以启用默认调试日志 CONTINUOUS_DEBUG 真实的.

发展

成熟度

这个SDK是在β中,在版本之间可能会有断裂的更改,而没有主要的版本更新. 因此,我们建议使用 到特定软件包版本。 这样,您可以每次安装同一版本而不中断更改,除非您是故意的 正在寻找最新版本.

捐款

虽然我们重视对SDK的开源贡献,但这个库是程序生成的. 任何加入内部文件的手动修改都会被覆盖到下一代上. 我们期待着听到你的反馈。 随便你开个公关 或一个有概念证明的问题 我们会尽力把它纳入未来的发行.

SDK 创建者 说话方便