# @faable/sdk-base 中文文档

规范地址：https://npmcn.com/package/%40faable/sdk-base/

版本：1\.8\.0
npm 元数据更新时间：2026-10-05T05:15:36.864Z
中文译文更新时间：2026-11-14T07:40:06.453Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40faable/sdk-base
原文对照：https://npmcn.com/package/%40faable/sdk-base/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：59.3 kB，47 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2024-09-27T10:41:06.851Z
- 最新版本发布：2026-10-05T05:15:36.669Z
- 近 30 天下载量：2426（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：33（近 12 个月 14 个）

## 中文简介

[](https://faable.com/)

# [SDK 软件 构建器基础代码](https://faable.com/)

[](https://faable.com/)

为 Fable API 构建 SDK 客户端

## 安装

```sh
npm install @faable/sdk-base
```

也可以使用：`pnpm add @faable/sdk-base`、`yarn add @faable/sdk-base`、`bun add @faable/sdk-base`

## README

[](https://faable.com/)

# [SDK 软件 构建器基础代码](https://faable.com/)

[](https://faable.com/)

为 Fable API 构建 SDK 客户端

[![](https://img.shields.io/npm/v/@faable/sdk-base.svg?style=for-the-badge&labelColor=000000)](https://www.npmjs.com/package/@faable/sdk-base)

## 安装

```bash
 npm install @faable/sdk-base
```

## 构建 API 客户端

扩展 `FaableApi` 呼叫静态 `create` 工厂:

```ts
import { FaableApi } from "@faable/sdk-base";
import type { ApiParams } from "@faable/sdk-base";

export class MyApi extends FaableApi {
  constructor(params?: ApiParams) {
    super({ baseURL: "https://api.example.com", ...params });
  }
  getThing(id: string) {
    return this.fetcher.get(`/thing/${id}`);
  }
}
```

## 认证( 可插件, Octokit 风格)

认证是 **明确** ——战略从不读取环境变量. 你选一个 `authStrategy` 并传递其配置 `auth`;选定的策略驱动 类型 `auth`因此编辑器自动完成正确的字段并拒绝 错的.

```ts
import { authClientCredentials, authApikey } from "@faable/sdk-base";

// client_credentials — the DEFAULT strategy. `auth` requires
// { client_id, client_secret }.
const api = MyApi.create({
  baseURL: "https://my-account.auth.faable.link",
  authStrategy: authClientCredentials,
  auth: { client_id: "...", client_secret: "..." },
});

// api key — `auth` requires { apikey }.
const api2 = MyApi.create({
  baseURL: "https://api.example.com",
  authStrategy: authApikey,
  auth: { apikey: "fak_xxx" },
});
```

`authClientCredentials` 请求其代号来自 `<baseURL>/oauth/token` 以 默认。 当 API 主机是 **没有** 认证服务器,指向符号请求 在右侧主机 `auth.domain`数字 :

```ts
auth: { client_id: "...", client_secret: "...", domain: "https://auth.example.com" }
```

### 写入自定义策略

战略就是建设者 `(config, context) => { headers() }`数字 :

```ts
import type { AuthStrategyBuilder } from "@faable/sdk-base";

type BearerConfig = { token: string };

export const authBearer: AuthStrategyBuilder<BearerConfig> = (config) => {
  if (!config?.token) throw new Error("authBearer: `auth.token` is required");
  return {
    headers: async () => ({ authorization: `Bearer ${config.token}` }),
  };
};
```

`context` 携带活人鱼 `domain` (数量) `baseURL`和 `debug` 旗帜,所以 符号最小化策略可以在不附加配置的情况下到达认证服务器 .

## 常见问题

### @faable/sdk-base 是什么？

SDK 软件 构建器基础代码 为 Fable API 构建 SDK 客户端

### 如何安装 @faable/sdk-base？

在项目目录运行 npm install @faable/sdk-base，或使用 pnpm add / yarn add / bun add。

### @faable/sdk-base 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @faable/sdk-base 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @faable/sdk-base 可以商用吗？

@faable/sdk-base 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @faable/sdk-base 的下载量有多少？

根据 npm 官方下载统计，@faable/sdk-base 在 2026/10/14 – 2026/11/12 这 30 天内被下载 2,426 次，日均约 81 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @faable/sdk-base 还在维护吗？

最新版本 1\.8\.0 发布于 2026/10/05（1 个月前）；至今共发布 33 个版本，其中过去 12 个月发布了 14 个；首次发布于 2024/09/27。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。