@alienplaft/manager-api (英语)

开发者友好型和型号安全型 SDK 专门适应杠杆 @alienplaft/manager-api (英语) API (英语).

[大 这个SDK还没有准备好用于生产. 为完成设置,请遵循您在《公约》 工作空间。在 > 发布到软件包管理器之前删除本节.

内容提要

外星管理人API:用于外星应用的控制平面. 管理部署、发布、命令和遥测.

目录

• @alienplaft/manager-api (英语)
  • SDK 安装
  • 所需资源
  • SDK 示例使用法
  • 认证
  • 现有资源和业务
  • 独立职能
  • 检索
  • 处理错误
  • 自定义 HTTP 客户端
  • 调试
• 发展
  • 成熟度
  • 捐款

SDK 安装

[TIP] 要完成将您的 SDK 发布到 npm 和其他您必须 运行您的第一代动作。 。 。 .

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

国家预防机制

npm add <UNSET>

菲律宾

pnpm add <UNSET>

阿宝

bun add <UNSET>

雅伦

yarn add <UNSET>

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

所需资源

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

SDK 示例使用法

示例

import { AlienManager } from "@alienplatform/manager-api";

const alienManager = new AlienManager({
  serverURL: "https://api.example.com",
  bearer: process.env["ALIEN_MANAGER_BEARER"] ?? "",
});

async function run() {
  const result = await alienManager.health.health();

  console.log(result);
}

run();

认证

常客安全计划

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

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

import { AlienManager } from "@alienplatform/manager-api";

const alienManager = new AlienManager({
  serverURL: "https://api.example.com",
  bearer: process.env["ALIEN_MANAGER_BEARER"] ?? "",
});

async function run() {
  const result = await alienManager.health.health();

  console.log(result);
}

run();

现有资源和业务

独立职能

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

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

检索

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

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

import { AlienManager } from "@alienplatform/manager-api";

const alienManager = new AlienManager({
  serverURL: "https://api.example.com",
  bearer: process.env["ALIEN_MANAGER_BEARER"] ?? "",
});

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

  console.log(result);
}

run();

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

import { AlienManager } from "@alienplatform/manager-api";

const alienManager = new AlienManager({
  serverURL: "https://api.example.com",
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  bearer: process.env["ALIEN_MANAGER_BEARER"] ?? "",
});

async function run() {
  const result = await alienManager.health.health();

  console.log(result);
}

run();

处理错误

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

示例

import { AlienManager } from "@alienplatform/manager-api";
import * as errors from "@alienplatform/manager-api/models/errors";

const alienManager = new AlienManager({
  serverURL: "https://api.example.com",
  bearer: process.env["ALIEN_MANAGER_BEARER"] ?? "",
});

async function run() {
  try {
    const result = await alienManager.bindings.resolveBinding({
      deploymentId: "<id>",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.AlienManagerError) {
      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.AlienError) {
        console.log(error.data$.code); // string
        console.log(error.data$.context); // any
        console.log(error.data$.hint); // string
        console.log(error.data$.httpStatusCode); // number
        console.log(error.data$.internal); // boolean
      }
    }
  }
}

run();

错误分类

主错误 :

• AlienManagerError: HTTP 错误响应的基础类.

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

自定义 HTTP 客户端

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

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

以下示例说明如何使用 "beforeRequest" 要添加的钩子 自定义标题和请求的超时及如何使用 "requestError" 钩子 记录错误 :

import { AlienManager } from "@alienplatform/manager-api";
import { HTTPClient } from "@alienplatform/manager-api/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

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 AlienManager({ httpClient: httpClient });

调试

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

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

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

import { AlienManager } from "@alienplatform/manager-api";

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

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

发展

成熟度

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

捐款

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

SDK 创建者 说话方便