# @elastic/schemas 中文文档

规范地址：https://npmcn.com/package/%40elastic/schemas/

版本：0\.11\.0
npm 元数据更新时间：2026-10-29T19:54:10.083Z
中文译文更新时间：2026-11-13T10:39:59.748Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40elastic/schemas
原文对照：https://npmcn.com/package/%40elastic/schemas/?lang=original
项目主页：https://github.com/elastic/schemas-js
源码仓库：https://github.com/elastic/schemas-js

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

- 包体积（解压后）：116 MB，29174 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- 首次发布：2026-07-21T19:40:41.255Z
- 最新版本发布：2026-10-29T19:54:09.722Z
- 近 30 天下载量：227647（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 22 个）

## 中文简介

所有弹性API的请求和响应计划

## 安装

```sh
npm install @elastic/schemas
```

也可以使用：`pnpm add @elastic/schemas`、`yarn add @elastic/schemas`、`bun add @elastic/schemas`

## README

# 弹性Schemas

![@elastic/schemas](https://img.shields.io/npm/v/%40elastic%2Fschemas) ![Build status](https://img.shields.io/github/actions/workflow/status/elastic/schemas-js/ci.yml)

所有弹性API的Schema定义,包括"弹性搜索","基巴纳"和"云". 多种形式:

-   [佐德语Name](https://zod.dev/) 计划
-   简单的 JSON 计划
-   为基于 LLM 的代理优化的工具注册

还包括基本设施,用于建造HTTP API请求,这些请求来自与所提供的计划之一相匹配的投入.

## 安装

从 npm 安装 :

```sh
npm install @elastic/schemas
```

### 可选依赖关系

**佐德语Name** 是一种可选的依赖。 如果只需要JSON schemas或工具注册,则不需要安装Zod. 如果您想要使用Zod schemas,请明确安装:

```sh
npm install zod
```

## 使用量

### JSON 计划

静态 [杰森·斯克马](https://json-schema.org/) 每个API的请求和响应都有文件。 命名空格 API 名称 `{namespace}.{name}.request.json`; 顶级( 全球) API 命名 `{name}.request.json`。 。 。 .

```typescript
import searchRequest from '@elastic/schemas/es/json/search.request.json' with { type: 'json' }
import searchResponse from '@elastic/schemas/es/json/search.response.json' with { type: 'json' }
```

```typescript
import findRulesRequest from '@elastic/schemas/kibana/json/find_rules.request.json' with { type: 'json' }
```

```typescript
import createApiKeyRequest from '@elastic/schemas/cloud/json/create_api_key.request.json' with { type: 'json' }
```

计划可以直接使用任何JSON Schema验证器,例如. [亚日弗](https://ajv.js.org/)数字 :

```typescript
import Ajv from 'ajv'
import searchRequest from '@elastic/schemas/es/json/search.request.json' with { type: 'json' }

const ajv = new Ajv()
const validate = ajv.compile(searchRequest)

const valid = validate({ index: 'my-index', query: { match_all: {} } })
if (!valid) console.error(validate.errors)
```

### Zod 计划

如果您安装了 Zod, 请用其模块路径导入单个计划, 并像任何 Zod 计划一样使用 :

```typescript
import { SearchRequest } from '@elastic/schemas/es/schemas/search.js'

const result = SearchRequest.safeParse({
  index: 'my-index',
  query: { match: { title: 'elasticsearch' } },
  size: 10,
})

if (!result.success) {
  console.error(result.error.issues)
}
```

### 工具登记

由 API ID 装入工具定义并构建一个随时发送的 HTTP 请求 :

```typescript
import { esRegistry } from '@elastic/schemas/es/tools/index.js'

const api = await esRegistry.loadApi('search')

const request = api.buildRequest({
  index: 'my-index',
  query: { match: { title: 'elasticsearch' } },
  size: 10,
})
// { method: 'GET', path: '/my-index/_search', body: { query: ..., size: 10 } }
```

每个装入 `definition` 携带两面分类旗. `destructive` 标记删除或变异的操作 现有数据. `readOnly` 标记只读取的操作:每一次GET和HEAW呼叫,但有副作用的操作除外, 加上搜索风格 POST 调用 `count` 或者说 `sql.query`。只读操作绝不具有破坏性。 一样 jSON Schema 请求文档中的旗帜为 `x-destructive` 财务报告和审定财务报表 `x-read-only`。 。 。 .

通过 `esRegistry.manifest` (数量 `{ id, name, namespace, description, destructive, readOnly }` 条目).

### 工具清单

每种产品都暴露出一个清单: `ApiRegistryMeta` 描述每个可用的 API 对象 (`{ id, name, namespace, description, namespaceFile, destructive, readOnly }`) (中文(简体) ). 这个 `destructive` 财务报告和审定财务报表 `readOnly` 旗帜与已加载的定义相匹配,因此可以在不加载任何定义的情况下通过分类过滤API. 无需装入任何计划代码即可直接导入清单 :

```typescript
import { kibanaManifest } from '@elastic/schemas/kibana/tools/manifest.js'
import { esManifest } from '@elastic/schemas/es/tools/manifest.js'
import { cloudManifest } from '@elastic/schemas/cloud/tools/manifest.js'
import { serverlessManifest } from '@elastic/schemas/serverless/tools/manifest.js'
```

这个 `ApiRegistryMeta` 主切入点导出类型 :

```typescript
import type { ApiRegistryMeta } from '@elastic/schemas'
```

### 可用出口

: 警告: 将所有计划导入为单个对象将消耗 **经常** 所以,我们鼓励你使用你需要的 计划的确切路径:

```js
import { SearchRequest } from '@elastic/schemas/es/schemas/search.js'
```

但是,如果您确实需要完全出口,则提供下列出口:

| 导出 | 说明 |
| --- | --- |
| `ElasticsearchSchemas` | 所有ES API 的 Zod 计划 |
| `ElasticsearchTools` | ES 工具登记册+ `esRegistry` |
| `KibanaSchemas` | 所有 Kibana API 的 Zod 计划 |
| `KibanaTools` | Kibana 工具登记册 + `kibanaRegistry` |
| `CloudSchemas` | 所有云层API的 Zod 计划 |
| `CloudTools` | 云工具登记+ `cloudRegistry` |
| `ServerlessSchemas` | 用于所有无服务器 API 的 Zod 方案 |
| `ServerlessTools` | 无服务器工具注册 + `serverlessRegistry` |
| `ApiRegistryMeta` | 显示条目的共享类型 |

## 版本支持

本套件中的"计划"反映了Elasticsearch Serverness最新发布的"Elasticsearch"和"Kibana"的API规格,也反映了Elastic Cloud Control平面API的最新稳定发布. 对其它版本"弹性堆栈"的支持即将到来!!

## 常见问题

### @elastic/schemas 是什么？

所有弹性API的请求和响应计划

### 如何安装 @elastic/schemas？

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

### @elastic/schemas 支持 TypeScript 吗？

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

### @elastic/schemas 支持 ESM 还是 CommonJS？

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

### @elastic/schemas 需要什么版本的 Node\.js？

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

### @elastic/schemas 可以商用吗？

@elastic/schemas 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @elastic/schemas 的下载量有多少？

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

### @elastic/schemas 还在维护吗？

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