# @gitbeaker/rest 中文文档

规范地址：https://npmcn.com/package/%40gitbeaker/rest/

版本：44\.1\.3
npm 元数据更新时间：2026-11-16T02:37:55.942Z
中文译文更新时间：2026-11-16T10:30:11.422Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：103 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=v24\.16\.0
- 运行依赖：2 个
- 首次发布：2023-03-14T05:01:45.769Z
- 最新版本发布：2026-11-16T02:37:55.572Z
- 近 30 天下载量：8234360（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：158（近 12 个月 29 个）

## 中文简介

跨平台执行 GitLab API

## 安装

```sh
npm install @gitbeaker/rest
```

也可以使用：`pnpm add @gitbeaker/rest`、`yarn add @gitbeaker/rest`、`bun add @gitbeaker/rest`

## README

  
  
![gitbeaker](https://npmcn.com/package/.github/ASSETS/header.svg)  
  
  

* * *

[我的开源工作得到了社区的支持](https://github.com/jdalrymple)

  
特别感谢:  
  
[![](https://npmcn.com/package/.github/ASSETS/coderabbit.png)](http://coderabbit.ai/)  
  

* * *

 [![CircleCI](https://dl.circleci.com/status-badge/img/gh/jdalrymple/gitbeaker/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/jdalrymple/gitbeaker/tree/main)[![REST Coverage](https://img.shields.io/codecov/c/github/jdalrymple/gitbeaker?flag=rest&logo=codecov&label=coverage) ](https://codecov.io/gh/jdalrymple/gitbeaker)[![Auto](https://img.shields.io/badge/release-auto.svg?colorA=888888&colorB=9B065A&label=auto) ](https://github.com/intuit/auto)[![All Contributors](https://img.shields.io/badge/all_contributors-orange.svg?style=round) ](https://npmcn.com/package/%40gitbeaker/rest/#readme-contributors-)![Prettier](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg) [![Licence: MIT](https://img.shields.io/badge/License-MIT-yellow.svg) ](https://npmcn.com/package/%40gitbeaker/rest/LICENSE.md)[![Install Size: Rest](https://packagephobia.com/badge?p=@gitbeaker/rest)](https://packagephobia.com/result?p=@gitbeaker/rest)

> 类型 [吉特拉布语Name](https://gitlab.com/gitlab-org/gitlab/) 浏览器的SDK, Node.js, and Deno.

## 目录

-   [目录](https://npmcn.com/package/%40gitbeaker/rest/#readme-table-of-contents)
-   [特征](https://npmcn.com/package/%40gitbeaker/rest/#readme-features)
-   [使用量](https://npmcn.com/package/%40gitbeaker/rest/#readme-usage)
-   [API 客户端](https://npmcn.com/package/%40gitbeaker/rest/#readme-api-client)
    -   [扩大的有效载荷](https://npmcn.com/package/%40gitbeaker/rest/#readme-expanded-payloads)
    -   [倾斜](https://npmcn.com/package/%40gitbeaker/rest/#readme-pagination)
        -   [偏移倾斜](https://npmcn.com/package/%40gitbeaker/rest/#readme-offset-pagination)
        -   [键集缓存](https://npmcn.com/package/%40gitbeaker/rest/#readme-keyset-pagination)
    -   [费率限制](https://npmcn.com/package/%40gitbeaker/rest/#readme-rate-limits)
    -   [处理错误](https://npmcn.com/package/%40gitbeaker/rest/#readme-error-handling)
-   [实例](https://npmcn.com/package/%40gitbeaker/rest/#readme-examples)
-   [贡献者](https://npmcn.com/package/%40gitbeaker/rest/#readme-contributors)

## 特征

-   **完成** - GitLab所有被曝光的API的特性都覆盖到版本上 [16.5 (中文(简体) )](https://docs.gitlab.com/16.5/ee/api/api_resources.html)。见 [这里](https://npmcn.com/packages/core/README.md#supported-apis) 完整名单.
-   **通用** - 在所有现代浏览器中工作, [节点.js](https://nodejs.org/),以及 [德诺](https://deno.land/)。 。 。 .
-   **已测试** 所有图书馆的测试覆盖率都大于80%.
-   **类型** - 所有库都有广泛的TypeScript声明.

## 使用量

<table><tbody><tr><th>浏览器</th><td>装入 <code>@gitbeaker/rest</code> 直接从 <a href="https://esm.sh/" rel="nofollow noopener noreferrer">esm.sh (英语)</a><pre><code class="language-html">&lt;script type="module"&gt;
  import { Gitlab } from 'https://esm.sh/@gitbeaker/rest';
&lt;/script&gt;
</code></pre></td></tr><tr><th>德诺</th><td>装入 <code>@gitbeaker/rest</code> 直接从 <a href="https://esm.sh/" rel="nofollow noopener noreferrer">esm.sh (英语)</a><pre><code class="language-ts">import { Gitlab } from 'https://esm.sh/@gitbeaker/rest?dts';
</code></pre></td></tr><tr><th>节点18+</th><td><p>安装方式 <code>npm install @gitbeaker/rest</code>, (中文(简体) ), <code>yarn add @gitbeaker/rest</code>,或 <code>pnpm add @gitbeaker/rest</code></p><pre><code class="language-js">import { Gitlab } from '@gitbeaker/rest';
</code></pre></td></tr></tbody></table>

## API 客户端

使用您创建的基本符号来证明图书馆 [GitLab 简介](https://docs.gitlab.com/user/profile/personal_access_tokens/)

```javascript
const api = new Gitlab({
  token: 'personaltoken',
});
```

可用的即时选择 :

| 名称 | 可选 | 默认 | 说明 |
| --- | --- | --- | --- |
| `host` | 对 | `https://gitlab.com` | Gitlab 实例主机 URL |
| `token` | 对\* | 不详 | 个人托肯. 建议(建议3个标志之一) |
| `oauthToken` | 对\* | 不详 | (原始内容存档于2018-03-27). OAuth Token. 建议(建议3个标志之一) |
| `jobToken` | 对\* | 不详 | CI乔布·托肯. 建议(建议3个标志之一) |
| `rejectUnauthorized` | 对 | `true` | Http 证书设置, 仅适用于非浏览器发布和 HTTPS 主机 urls |
| `sudo` | 对 | `false` | [须藤](https://docs.gitlab.com/api/rest/authentication/#sudo) 查询参数 |
| `camelize` | 对 | `false` | 凸起所有响应体键 |
| `requesterFn` | 没有 | @gitbeaker/ rest & @gitbeaker/cli:基于抓取的,该 @gitbeaker/核心包 **没有** 存在默认,因此必须明确设定 | 请求图书馆收发器 |
| `queryTimeout` | 对 | `300000` | 查询超时( ms) |
| `profileToken` | 对 | 不详 | [请求配置文件](https://docs.gitlab.com/administration/monitoring/performance/) |
| `profileMode` | 对 | `execution` | [请求配置文件](https://docs.gitlab.com/administration/monitoring/performance/) |
| `rateLimits` | 没有 | [国防 战争 战斗](https://npmcn.com/package/%40gitbeaker/rest/#readme-rate-limits) | 全球和终点特定可调整费率限额 |
| `rateLimitDuration` | 没有 | `60` | 达到费率限制时的暂停时间 |

> \* 应提供其中之一,因为大多数API请求需要认证.

### 扩大的有效载荷

为了简单起见,只有反应体从API方法返回. 然而,看到额外的响应领域,如状态,标题等,可能是有益的. 为此,增加一个可选参数, `showExpanded` 可以通过大多数 API 方法.

对于返回未粘贴结果的方法,有效载荷具有这种结构:

```ts
type ResponseBodyTypes =
  | Record<string, unknown>
  | Record<string, unknown>[]
  | ReadableStream
  | Blob
  | string
  | string[]
  | number
  | void
  | null;

interface FormattedResponse<T extends ResponseBodyTypes = ResponseBodyTypes> {
  body: T;
  headers: Record<string, string>;
  status: number;
}
```

对于返回被粉碎后结果的方法,有效载荷还包括载于 [铺设文件](https://npmcn.com/package/%40gitbeaker/rest/#readme-pagination)

### 倾斜

可用的页码选项 :

| 名称 | 密钥集 | 折减 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- | --- | --- |
| `pagination` | 页:1 | 页:1 | "抵消"或"键盘" | "抵消" | 定义应当使用的页形类型 |
| `perPage` | 页:1 | 页:1 | 数目 | 20国 | 每个请求的结果数额 |
| `orderBy` | 页:1 |  | 字符串 |  | 哪些领域的结果应该由 |
| `sort` | 页:1 |  | “ asc” 或“ desc” | 亚士克 | 结果的排序方向 |
| `maxPages` |  | 页:1 | 数目 | 不详 | 最多应提出请求的数量 |
| `page` |  | 页:1 | 数目 | 不详 | 要检索的特定页面 |
| `showExpanded` |  | 页:1 | 布尔 | 虚假 | 除数据外随页标信息返回 |

#### 偏移倾斜

对于资源上的任何.all () 函数,它将返回 **全部** gitLab提供的物品。 如果有许多项目,这可能会很麻烦,因为请求本身需要一段时间才能完成。 因此,可以通过最大Pages选项来限制所有函数的范围.

```javascript
import { Gitlab } from '@gitbeaker/rest';

const api = new Gitlab({
  host: 'http://example.com',
  token: 'personaltoken',
});

let projects = await api.Projects.all({ maxPages: 2 });
```

您也可以结合 perPage 参数使用此参数, 该参数将取代 Gitlab 设定的每页 30 的默认值 :

```javascript
import { Gitlab } from '@gitbeaker/rest';

const api = new Gitlab({
  host: 'http://example.com',
  token: 'personaltoken',
});

let projects = await api.Projects.all({ maxPages: 2, perPage: 40 });
```

此外,如果您想要获取页码信息, 需要了解总页有多少页, 例如, 通过选项 `showExpanded`。如果有多种结果,则将包含标记属性如下:

```javascript
...
const { data, paginationInfo } = await api.Projects.all({
  perPage:40,
  maxPages:2,
  showExpanded: true
});
...
```

这将导致以这种形式作出反应:

```javascript
data: [
...
],
paginationInfo: {
  next: 4,
  current: 2,
  previous: 1,
  perPage: 3,
}
```

> 注:提供任何帕吉化限制都称为密集。 一些资源需要许多要求,这些要求可以给GitLab服务器带来大量负荷。 一般最佳做法是,在不需要所有结果的情况下,规定只返回第一页的页面请求选项.

#### 键集缓存

同样,支持 [密钥集映射](https://docs.gitlab.com/api/rest/#keyset-based-pagination) 可以通过 pagination 参数作为查询选项来切换

```js
const { data } = await api.Projects.all({
  pagination: 'keyset',
  sort: 'asc',
  orderBy: 'created_at',
});
```

### 费率限制

速率限制是完全自定义的,用于限制库内连续API请求之间的请求速率. 默认情况下,所有未指定的端点都使用3000 rps的速率限制,而一些端点的速率则要小得多,因为 [GitLab 文档](https://docs.gitlab.com/security/rate_limits/)。关于默认值,见下文:

```js
const DEFAULT_RATE_LIMITS = Object.freeze({
  // Default rate limit
  '**': 3000,

  // Import/Export
  'projects/import': 6,
  'projects/*/export': 6,
  'projects/*/download': 1,
  'groups/import': 6,
  'groups/*/export': 6,
  'groups/*/download': 1,

  // Note creation
  'projects/*/issues/*/notes': {
    method: 'post',
    limit: 300,
  },
  'projects/*/snippets/*/notes': {
    method: 'post',
    limit: 300,
  },
  'projects/*/merge_requests/*/notes': {
    method: 'post',
    limit: 300,
  },
  'groups/*/epics/*/notes': {
    method: 'post',
    limit: 300,
  },

  // Repositories - get file archive
  'projects/*/repository/archive*': 5,

  // Project Jobs
  'projects/*/jobs': 600,

  // Member deletion
  'projects/*/members': 60,
  'groups/*/members': 60,
});
```

速率限制可以在即时API包装时被推翻. 为了便于使用,这些限制是使用 glob 模式来配置的,可以有两种格式.

1.  带有相应每秒速率的终点缩放
2.  结束点的缩写, 指定结束点的具体方法和相应的速率限制的对象

您也可以覆盖 `rateLimitDuration` 默认值为 60 秒。 这是特定终点在达到速率限制时的超时时间.

```js
const api = new Gitlab({
  token: 'token',
  rateLimits: {
    '**': 30,
    'projects/import/*': 40,
    'projects/*/issues/*/notes': {
      method: 'post',
      limit: 300,
    },
  },
  rateLimitDuration: 30,
});
```

### 处理错误

请求出错会在纯错误实例中返回, 使用原因来持有原始响应, 以及从 JSON 的响应出错或信件字段中提取的对出错的文本描述, 或其纯文本值 :

```ts
class GitbeakerError extends Error {
  constructor(
    message: string,
    options?: {
      cause: {
        description: string;
        request: Request;
        response: Response;
      };
    },
  ) {
    super(message, options);
    this.name = 'GitbeakerError';
  }
}
```

注意,信息被分配到反应 `statusText`,则 [请求](https://nodejs.org/dist/latest-v18.x/docs/api/globals.html#request) 财务报告和审定财务报表 [回应](https://nodejs.org/dist/latest-v18.x/docs/api/globals.html#response) 类型来自节点JS API.

## 实例

一旦您的库被即时化, 您可以使用许多 API 的功能 :

使用等待/同步方法

```javascript
import { Gitlab } from '@gitbeaker/rest';

const api = new Gitlab({
  host: 'http://example.com',
  token: 'personaltoken',
});

// Listing users
let users = await api.Users.all();

// Or using Promise-Then notation
api.Projects.all().then((projects) => {
  console.log(projects);
});
```

关于所有函数参数的通则 :

-   如果它是一个必需的参数, 它就是函数中的一个命名的参数
-   如果它是一个可选参数,则按照命名参数在选项对象中定义

没错.

```javascript
import { Projects } from '@gitbeaker/rest';

const projectsAPI = new Projects({
  host: 'http://example.com',
  token: 'personaltoken',
});

projectsAPI.create({
  //options defined in the GitLab API documentation
});
```

## 贡献者

[![Justin Dalrymple](https://images.weserv.nl/?url=https://avatars3.githubusercontent.com/u/3743662?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/jdalrymple) [![Dylan DesRosier](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/13701258?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/dylandesrosier) [![Mike Wyatt](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/4729?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/mikew) [![Cory Zibeill](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/7986014?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/coryzibell) [![Martin Bour](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/5209850?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/shadygrove) [![akira345](https://images.weserv.nl/?url=https://avatars0.githubusercontent.com/u/655764?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/akira345) [![Pavel Birukov ](https://images.weserv.nl/?url=https://avatars2.githubusercontent.com/u/1861546?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://birukov.me/) [![Joseph Petersen](https://images.weserv.nl/?url=https://avatars2.githubusercontent.com/u/1661688?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](http://jetersen.dev/) [![Louis Cherel](https://images.weserv.nl/?url=https://avatars3.githubusercontent.com/u/563373?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/Musinux) [![Adam Dehnel](https://images.weserv.nl/?url=https://avatars3.githubusercontent.com/u/1697162?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](http://www.arsdehnel.net/) [![Ev Haus](https://images.weserv.nl/?url=https://avatars3.githubusercontent.com/u/226640?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](http://www.haus.gg/) [![Loïc Mahieu](https://images.weserv.nl/?url=https://avatars0.githubusercontent.com/u/900947?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](http://igloo.be/) [![Giuseppe Angri](https://images.weserv.nl/?url=https://avatars2.githubusercontent.com/u/9075163?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](http://www.giuseppeangri.com/) [![jennparise](https://images.weserv.nl/?url=https://avatars1.githubusercontent.com/u/4134086?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/jennparise) [![Oscar](https://images.weserv.nl/?url=https://avatars0.githubusercontent.com/u/3877773?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](http://obartra.github.io/) [![Daniel Ruf](https://images.weserv.nl/?url=https://avatars1.githubusercontent.com/u/827205?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://daniel-ruf.de/) [![schindld](https://images.weserv.nl/?url=https://avatars0.githubusercontent.com/u/1659632?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/schindld) [![Alvaro](https://images.weserv.nl/?url=https://avatars0.githubusercontent.com/u/12004383?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://alvarobg.com/) [![Daniel Moore](https://images.weserv.nl/?url=https://avatars3.githubusercontent.com/u/616152?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](http://northhorizon.net/) [![Dylan M. Taylor](https://images.weserv.nl/?url=https://avatars2.githubusercontent.com/u/277927?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://dylanmtaylor.com/) [![Corentin Mors](https://images.weserv.nl/?url=https://avatars1.githubusercontent.com/u/4266283?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://pixelswap.fr/) [![xatavian](https://images.weserv.nl/?url=https://avatars1.githubusercontent.com/u/17217965?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/xatavian) [![Yevgeny Petukhov](https://images.weserv.nl/?url=https://avatars3.githubusercontent.com/u/11796206?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://stackoverflow.com/story/yepninja) [![Mickaël Tricot](https://images.weserv.nl/?url=https://avatars2.githubusercontent.com/u/378910?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://about.me/mickaeltr) [![Andrea](https://images.weserv.nl/?url=https://avatars0.githubusercontent.com/u/181780?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/andreasciamanna) [![Flavien Bridault](https://images.weserv.nl/?url=https://avatars0.githubusercontent.com/u/8638653?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](http://www.ircad.fr/) [![s-kazuki](https://images.weserv.nl/?url=https://avatars2.githubusercontent.com/u/9253374?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/s-kazuki) [![Kipras Melnikovas](https://images.weserv.nl/?url=https://avatars3.githubusercontent.com/u/29430509?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/kiprasmel) [![xieyu](https://images.weserv.nl/?url=https://avatars0.githubusercontent.com/u/27680715?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/Gkxie) [![st1gok](https://images.weserv.nl/?url=https://avatars1.githubusercontent.com/u/13641693?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/st1gok) [![Max Wittig](https://images.weserv.nl/?url=https://avatars3.githubusercontent.com/u/6639323?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/max-wittig) [![Niklas Lochschmidt](https://images.weserv.nl/?url=https://avatars3.githubusercontent.com/u/759624?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/nlochschmidt) [![Ilya Dus](https://images.weserv.nl/?url=https://avatars3.githubusercontent.com/u/26578665?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/illyaMs) [![Omar Awamry](https://images.weserv.nl/?url=https://avatars0.githubusercontent.com/u/32439651?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/wamry) [![Hennadii Varava](https://images.weserv.nl/?url=https://avatars0.githubusercontent.com/u/15640910?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/Sumragen) [![xiezht](https://images.weserv.nl/?url=https://avatars1.githubusercontent.com/u/18051618?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/xiezht) [![Martin Helmich](https://images.weserv.nl/?url=https://avatars3.githubusercontent.com/u/2538958?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](http://www.martin-helmich.de/en) [![Sean McGivern](https://images.weserv.nl/?url=https://avatars0.githubusercontent.com/u/1120328?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/smcgivern) [![Clemens Lieb](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/7288995?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/Vogel612) [![Vojtěch Sajdl](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/5222912?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://sajdl.com/) [![divido](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/4614626?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/divido) [![Vincent Boulaye](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/652767?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/vboulaye) [![Aliyss Snow](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/33941859?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/Aliyss) [![Mahmoud Saada](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/1087987?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/saada) [![Feng Yu](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/12343178?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/F3n67u) [![Roy Jacobs](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/173822?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://datatra.sh/) [![Paul Lemke](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/976010?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](http://www.paullemke.com/) [![Ian Jenkins](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/131355?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](http://jenko.me/) [![nilennoct](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/4055220?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://www.nilennoct.com/) [![Laffargue Michael](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/503129?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](http://michael.laffargue.fr/) [![Martin Howarth](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/7187425?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/MartinHowarth) [![Christoph Lehmann](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/4953689?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/christophlehmann) [![Frank V](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/253471?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://theopensourceu.org/) [![Salim Benabbou](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/357286?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/Salimlou) [![Tamás Török-Vistai](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/1945260?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/tvtamas) [![Martin Benninger](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/20296116?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/MartinBenninger) [![fewieden](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/9334168?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/fewieden) [![Jeff Pelton](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/36627?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://www.jeffpelton.com/) [![Claude Abounegm](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/11809881?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/claude-abounegm) [![Stefan Hall](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/17978203?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/Marethyu1) [![Jordan Wallet](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/799000?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/Mr-Wallet) [![zhao0](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/7556666?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/zhao0) [![Joshua Grosso](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/4530584?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://www.linkedin.com/in/joshuagrosso) [![Isaac Ouellet Therrien](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/9469187?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/yonguelink) [![Rajat Sharma](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/24895138?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://wearecws.com/) [![Cesar B.](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/65105345?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/Casz) [![Igor Katsuba](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/10637135?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://blog.katsuba.dev/) [![Michael Townsend](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/4884483?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](http://www.doublespeakgames.com/) [![bodtx](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/1039550?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/bodtx) [![Artem](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/1815294?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/arthot) [![Munif Tanjim](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/8050659?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://muniftanjim.dev/) [![Quentin Dreyer](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/717869?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://www.qkdreyer.dev/) [![Norm MacLennan](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/192728?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://iwritethe.codes/) [![jnovick](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/7881319?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/jnovick) [![Fabian Aussems](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/57530?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://www.fabianaussems.com/) [![Michael Matzka](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/14311597?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/mima0815) [![CraigAllardyce](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/9052289?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/CraigAllardyce) [![Bruno Guimarães](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/320122?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/brunobastosg) [![Lukas Eipert](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/2906107?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](http://leipert.io/) [![Maximilian Krauß](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/914671?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://max.krauss.io/) [![Evolution Engineering](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/15799569?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://eng.evolution.com/) [![WEBER Logan](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/1135958?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/Neonox31) [![Anton Zhukov](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/5055654?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://t.me/mister_cheater) [![Nicholas Loomans](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/4149031?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/beaverusiv) [![Carl Kittelberger](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/807772?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://icedream.pw/) [![Patrik Votoček](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/112567?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://patrik.votocek.cz/) [![Kyrylo Fedorov](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/426462?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://kyr.github.io/CV/) [![Claudio Vellage](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/28930612?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/claudio-vellage) [![Seb0uil](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/5122626?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/seb0uil) [![Rafael Mello](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/3404989?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](http://merorafael.info/) [![Théis Bazin](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/9104039?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/tbazin) [![Spencer Salisbury](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/8053224?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](http://spencersalisbury.com/) [![Simone Corsi](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/5617452?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://simonecorsi.dev/) [![Bambii](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/34485027?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/Bambii556) [![Will](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/128541928?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/ravewill) [![ArnaudTA](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/33383276?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/ArnaudTA) [![Benjamin Beret](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/48335?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/kouak) [![Alessandro Diez](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/16702156?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/demedos) [![artlist-scottambrose](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/124692101?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/artlist-scottambrose) [![Martin Dreher](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/1114120?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/mercutiodesign) [![Elan Ruusamäe](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/199095?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/glensc) [![artemoire](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/18062266?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/Artemoire) [![Pieter Willekens](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/3403851?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/pataar) [![David Claybourne](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/761764?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/Djcd) [![Dom Harrington](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/848223?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/domharrington) [![Kohei Seino](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/1378066?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/kseino) [![JounQin](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/8336744?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://www.1stg.me/) [![Elaine Mattos](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/79633988?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/elaine-mattos) [![DK](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/10766587?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/vitamindck) [![Koen Brouwer](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/3260168?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](http://www.koenbrouwer.com/) [![Sefa Eyeoglu](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/11587657?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://scrumplex.net/) [![Carmi Raz](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/157008803?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/crazfb) [![Arnold Hendriks](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/2772353?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/unilynx) [![Baylee Schmeisser](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/119542904?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://baylee.dev/) [![Andy](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/13085980?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/andys8) [![roberta-pavel](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/26488965?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/roberta-pavel) [![Youssef](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/41103290?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/yousinix) [![Miguel](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/33475618?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/mpsanchis) [![Giannis Kepas](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/61121754?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/Retr0-01) [![Talysson de Oliveira Cassiano](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/4325587?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/talyssonoc) [![Marco](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/34128667?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/Sephyr0s) [![Endrik Einberg](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/19674002?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/enduity) [![Bryan Lee](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/38807139?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://note.itswhat.me/) [![Zack](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/42388953?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/zk-kb4) [![Kay W.](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/29700073?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/kayw-geek) [![Florian Imdahl](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/5497598?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://ffflorian.dev/) [![lanthier](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/9666344?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/lanthier) [![ShaoWei Teo](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/6925907?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/Teo-ShaoWei) [![Daniel Rentz](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/5064304?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/danielrentz) [![Matěj Smíšek](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/3141623?v=4&size=25&h=25&w=25&fit=cover&mask=circle&maxage=7d)](https://github.com/matejsmisek)

这是从一个叉子开始的 [节点- gitlab- 遗留](https://github.com/rest-gitlab/rest-gitlab-legacy) 但我最后重写了大部分代码 这是原作的 [捐助者](https://github.com/rest-gitlab/rest-gitlab-legacy#contributors)。 。 。 .

## 常见问题

### @gitbeaker/rest 是什么？

跨平台执行 GitLab API

### 如何安装 @gitbeaker/rest？

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

### @gitbeaker/rest 支持 TypeScript 吗？

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

### @gitbeaker/rest 支持 ESM 还是 CommonJS？

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

### @gitbeaker/rest 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=v24\.16\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @gitbeaker/rest 可以商用吗？

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

### @gitbeaker/rest 的下载量有多少？

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

### @gitbeaker/rest 还在维护吗？

最新版本 44\.1\.3 发布于 2026/11/16（今天）；至今共发布 158 个版本，其中过去 12 个月发布了 29 个；首次发布于 2023/03/14。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

