# @goauthentik/api 中文文档

规范地址：https://npmcn.com/package/%40goauthentik/api/

版本：2026\.8\.5
npm 元数据更新时间：2026-10-21T13:21:37.057Z
中文译文更新时间：2026-11-16T17:41:33.915Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40goauthentik/api
原文对照：https://npmcn.com/package/%40goauthentik/api/?lang=original
项目主页：https://github.com/goauthentik/client-ts#readme
源码仓库：https://github.com/goauthentik/client-ts

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

- 包体积（解压后）：37.7 MB，9634 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2021-08-15T19:11:07.757Z
- 最新版本发布：2026-10-21T13:21:36.497Z
- 近 30 天下载量：37758（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：718（近 12 个月 134 个）

## 中文简介

@ goauthentik/ api 的 OpenAPI 客户端

## 安装

```sh
npm install @goauthentik/api
```

也可以使用：`pnpm add @goauthentik/api`、`yarn add @goauthentik/api`、`bun add @goauthentik/api`

## README

## @goauthentik/ api (英语)

此软件包提供了一个生成的 API 客户端 [认证](https://goauthentik.io/?utm_source=npm-api-package)。 。 。 .

### 大楼

见 [https://docs.goauthentik.io/docs/developer-docs/api/making-schema-changers#建设-the-web-客户端](https://docs.goauthentik.io/docs/developer-docs/api/making-schema-changes#building-the-web-client)

### 消费

```
npm install @goauthentik/api --save
```

创建配置 :

```typescript
import { Configuration } from "@goauthentik/api";

export const DEFAULT_CONFIG = new Configuration({
    // Configure where the API is located
    // Can be a full host, ensure CORS is configured
    basePath: "",
    // Required for POST/PUT/DELETE requests
    // getCookie function must return the cookie's contents
    headers: {
        "X-authentik-CSRF": getCookie("authentik_csrf"),
    },
});
```

然后使用 API :

```typescript
import { CoreApi } from "@goauthentik/api";

const user = await new CoreApi(DEFAULT_CONFIG).coreUsersMeRetrieve();
```

## 常见问题

### @goauthentik/api 是什么？

@ goauthentik/ api 的 OpenAPI 客户端

### 如何安装 @goauthentik/api？

在项目目录运行 npm install @goauthentik/api，或使用 pnpm add / yarn add / bun add。

### @goauthentik/api 支持 TypeScript 吗？

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

### @goauthentik/api 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @goauthentik/api 可以商用吗？

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

### @goauthentik/api 的下载量有多少？

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

### @goauthentik/api 还在维护吗？

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

