# @celigo/api-specs 中文文档

规范地址：https://npmcn.com/package/%40celigo/api-specs/

版本：0\.2\.274
npm 元数据更新时间：2026-11-09T09:18:22.668Z
中文译文更新时间：2026-11-09T07:18:08.357Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40celigo/api-specs
原文对照：https://npmcn.com/package/%40celigo/api-specs/?lang=original
项目主页：https://developer.celigo.com/api/api-reference
源码仓库：https://github.com/celigo/integrator-api-specs

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

- 包体积（解压后）：10.8 MB，57 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>=20
- 运行依赖：0 个
- 首次发布：2026-08-31T20:06:34.125Z
- 最新版本发布：2026-11-09T09:18:22.453Z
- 近 30 天下载量：31501（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：280（近 12 个月 280 个）

## 中文简介

公共 OpenAPI 捆绑 (dist/) 和 cleigo- cli lint schema 包 (schemas.json).

## 安装

```sh
npm install @celigo/api-specs
```

也可以使用：`pnpm add @celigo/api-specs`、`yarn add @celigo/api-specs`、`bun add @celigo/api-specs`

## README

# @ celigo/ 图片

OpenAPI 3.2 规格 [Celigo 整合器.io](https://www.celigo.com/) 爱普, 被打包为工具文件 。 他们是背后的文件 [Celigo 开发者平台上的 API 引用](https://developer.celigo.com/api/api-reference), (中文(简体) ), 还有什么 [西丽戈CLI](https://developer.celigo.com/cli) 对资源文档进行校验.

```bash
npm install @celigo/api-specs
```

## 包裹里有什么

每个平台资源都有自己的 OpenAPI 文件 `dist/` - 连接、流动、出口、, 进口、集成、工作、脚本、工具以及其他。 每个文件都是自成一体的,每个文件 `$ref` ,因此可以直接进入客户端生成器、请求验证器或 AI代理的上下文没有加载器配置.

```
dist/connection.yml
dist/flow.yml
dist/export.yml
dist/import.yml
...
schemas.json
```

`schemas.json` 是西里戈CLI的图案 `celigo lint` 命令验证文档 反之,由同捆所编. 其他消费者可以忽略它.

以与其它已打包文件相同的方式解决文档 :

```js
import { createRequire } from "node:module";

const require = createRequire(import.meta.url);
const specPath = require.resolve("@celigo/api-specs/dist/connection.yml");
```

## API 这些规格描述

所有行动都在 `/v1/` 前缀并用无记名符号认证 (单位:千美元)`Authorization: Bearer <token>`) (中文(简体) ). 在下方创建符号集成.io **资源** > 翻译: **API 令牌**。 。 。 .

API服务于四个区域主机. 用你的账户里住的那个:

| 地区 | 基础 URL |
| --- | --- |
| US( 默认) | `https://api.integrator.io` |
| 欧盟 | `https://api.eu.integrator.io` |
| 非盟 | `https://api.au.integrator.io` |
| 加利福尼亚 | `https://api.ca.integrator.io` |

API 管理(`/v1/apim/...`)只服务于美国和欧盟的东道主.

要交互浏览 API,请使用 [参考文献](https://developer.celigo.com/api/api-reference): 每个资源都有自己的资源 页面,并设有一个控制台,用于对自己的账户进行呼叫.

## 说明什么

规格为规范. 他们描述API表面 Celigo 支持并打算保留 支持 —— 不是服务器碰巧容忍的一切. 内部终点,被侵蚀的田地, 和已退休的元素值被故意忽略.

实际后果: 一个针对这些规格的请求是您可以借鉴的. 反之则不行. 服务器可能接受无说明的有效载荷,该有效载荷可能 后被忽略或拒绝.

## 扩展

除了标准的 OpenAPI 外,文档还带有 `x-` celigo工具读取的扩展 。 标准 OpenAPI 消费者可以忽略它们;验证器和AI代理可能发现它们有用.

| 延长 | 何处 | 含义 |
| --- | --- | --- |
| `x-enumDescriptions` | 字段为 `enum` | 解释它的作用. |
| `x-celigo-refModel` | 标识字段 | 资源类型 ID 点 `flows`, (中文(简体) ), `scripts`,等等). |
| `x-celigo-ai-guidance` | 外观和外观 | 对AI代理的操作提示:默认选择哪个,脚手架设置时设置什么,以及错误导致的具体故障. |
| `x-celigo-ui-override` | 外观和外观 | 标出一个可以反射成像器.io形式的要求或默认,它比原始的API更严格,因此所生成的配置是完整而可连接的. |
| `x-celigo-agent` | 表达字段 | 字段值以表达式语言或编辑器编写;其能力标记(`handlebars`, (中文(简体) ), `sql`, (中文(简体) ), `mapping`,...)告诉代理或工具哪个. |
| `x-celigo-handlebars-context` | 处理栏字段 | 用于评价表达式的数据背景,例如: `pre-mapped` 或者说 `post-mapped`。 。 。 . |
| `x-celigo-excludeAdaptorTypes` | 共享适配器字段 | 该字段不适用的适配器类型 . |
| `x-lowercase`, (中文(简体) ), `x-uppercase` | 字符串字段 | API 将值的大小写规范化 . |

`x-internal`, (中文(简体) ), `x-enable-proxy`,以及 `x-displayName` 控制文档工具链并携带无 API意义.

## 支助

对于规格的问题——与API不一致的策略,缺失的字段或终点,a 或与integrator.io本身联系 [Celigo 支持](https://docs.celigo.com/hc/en-us/requests/new)。最有用的报告名称为 光谱和操作,显示您提出的要求,并显示 API 返回到旁边 spec说它会。 永不包含API令牌,证书,或客户数据.

私人通过同一渠道报告疑似安全薄弱之处,包括: 涉及操作、它披露或促成什么以及复制步骤.

## 许可证

麻省理工学院. 这个 `LICENSE` 备案船在包裹。 规格描述为集成器.io API;使用 API本身受你的西里戈协议管辖.

## 常见问题

### @celigo/api-specs 是什么？

公共 OpenAPI 捆绑 \(dist/\) 和 cleigo- cli lint schema 包 \(schemas\.json\)\.

### 如何安装 @celigo/api-specs？

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

### @celigo/api-specs 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/celigo\_\_api-specs 是否存在。

### @celigo/api-specs 需要什么版本的 Node\.js？

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

### @celigo/api-specs 可以商用吗？

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

### @celigo/api-specs 的下载量有多少？

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

### @celigo/api-specs 还在维护吗？

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