# grexx-api 中文文档

规范地址：https://npmcn.com/package/grexx-api/

版本：13\.16\.8
npm 元数据更新时间：2026-11-03T16:12:16.122Z
中文译文更新时间：2026-11-03T19:29:21.305Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/grexx-api
原文对照：https://npmcn.com/package/grexx-api/?lang=original

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

- 包体积（解压后）：102 kB，130 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2025-04-03T15:08:43.406Z
- 最新版本发布：2026-11-03T16:12:15.895Z
- 已发布版本数：930（近 12 个月 501 个）

## 中文简介

Grexx平台API库

## 安装

```sh
npm install grexx-api
```

也可以使用：`pnpm add grexx-api`、`yarn add grexx-api`、`bun add grexx-api`

## README

# Grexx平台API - TypeScript客户端

的TypeScript客户端 **Grexx平台API**，由OpenAPI 3.0.2规范生成。它提供了与API端点交互的强类型接口。

## 目录表

-   [概述](https://npmcn.com/package/grexx-api/#readme-overview)
-   [安装](https://npmcn.com/package/grexx-api/#readme-installation)
-   [用法](https://npmcn.com/package/grexx-api/#readme-usage)
    -   [初始化](https://npmcn.com/package/grexx-api/#readme-initialization)
    -   [例子](https://npmcn.com/package/grexx-api/#readme-examples)

* * *

## 概述

这个 **Grexx平台API** 允许您与Grexx平台进行交互，以管理案例、数据集、表单、任务等。这个客户端提供了一种方便的方式来使用TypeScript类型和接口访问API，以获得更好的开发体验。

## 安装

使用npm或yarn安装客户端包：

```bash
npm install grexx-api-client
# or
yarn add grexx-api-client
```

## 用法

### 初始化

要使用客户机，请初始化 `OpenAPI` 使用您的Grexx平台的基本URL和任何所需的身份验证详细信息配置。

```typescript
import { OpenAPI } from 'grexx-api';

OpenAPI.BASE = 'https://name.grexx.today/api/v1';
OpenAPI.TOKEN = 'your-api-key'; // Replace with your API key if required
```

### 例子

#### 检索案例信息

```typescript
import { CaseService } from 'grexx-api';

const casePath = 'example-case-id';

CaseService.caseInfo(casePath, { css: true, rootline: false })
  .then(response => {
    console.log('Case Info:', response);
  })
  .catch(error => {
    console.error('Error fetching case info:', error);
  });
```

#### 提交任务

```typescript
import { CaseService } from 'grexx-api';

const taskId = 12345;
const casePath = 'example-case-id';

CaseService.taskSubmit(taskId, casePath, {
  fields: { fieldName: 'value' },
  autoProgress: true,
})
  .then(response => {
    console.log('Task submitted successfully:', response);
  })
  .catch(error => {
    console.error('Error submitting task:', error);
  });
```

## 常见问题

### grexx-api 是什么？

Grexx平台API库

### 如何安装 grexx-api？

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

### grexx-api 支持 TypeScript 吗？

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

### grexx-api 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### grexx-api 可以商用吗？

grexx-api 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### grexx-api 还在维护吗？

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