# @api3/ois 中文文档

规范地址：https://npmcn.com/package/%40api3/ois/

版本：3\.0\.0
npm 元数据更新时间：2026-04-07T10:33:23.298Z
中文译文更新时间：2026-11-06T09:57:10.334Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：171 kB，17 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2022-06-23T08:25:16.739Z
- 最新版本发布：2025-07-27T20:22:05.554Z
- 近 30 天下载量：4928（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 0 个）

## 中文简介

> OIS(或作甲骨文集成规格)是一个描述API规格的JSON对象

## 安装

```sh
npm install @api3/ois
```

也可以使用：`pnpm add @api3/ois`、`yarn add @api3/ois`、`bun add @api3/ois`

## README

# `@api3/ois`

> OIS(或作甲骨文集成规格)是一个描述API规格的JSON对象

您可以在网站上找到 OIS 的文档 [文档](https://airnode-docs.api3.org/reference/ois/latest/)。 。 。 .

## 安装

要安装 [此软件包](https://www.npmjs.com/package/@api3/ois) 运行 :

`pnpm add @api3/ois`

或者如果您使用 npm :

`npm install @api3/ois --save`

### 抓到他们了

#### 使用被绑定的版本

我们建议使用一个固定版的OIS包,因为包中包含的验证执行OIS 版本到补丁。 固定版本还确保您的项目使用正确的OIS版本,即使有 其他软件包取决于不同的OIS版本.

#### 确保只安装一个"zod"版本

内部,我们使用 [佐德语](https://github.com/colinhacks/zod) 为OIS计划执行验证和TS打字. 当一个项目使用多个不同的zod版本时,可能会有TS问题.

## 使用量

OIS软件包定义了验证和TypeScript打字,可用于验证完整的OIS图案的正确性或 只是它的一部分。 例如:

```js
const { oisSchema } = require('@api3/ois');

const possibleOis = {
  // Placeholder values. Refer to the Example section below and the documentation.
  oisFormat: '1.0.0',
  version: '1.2.3',
  title: 'coinlayer',
  apiSpecifications: { ... } // omitted for brevity
  endpoints: [ ... ], // omitted for brevity
};
const result = oisSchema.safeParse(possibleOis);
if (!result.success) {
  throw result.error
} else {
  const validOis = result.data
}
```

### 示例

可以找到一个有效的OIS的例子 [这里](https://github.com/api3dao/ois/blob/main/test/fixtures/ois.json)。 。 。 .

## 开发者文档

### 释放

GitHub 动作使用 [更改/行动](https://github.com/changesets/action)。发布 新版本遵循这些步骤:

1.  假设预期的更改出现在 `main` ,将 GitHub PR 创建到 `release` 分支从 `main`。 。 。 .
2.  合并 PR 为 `release` **使用合并执行**。 。 。 .
3.  这个 [发布动作工作流程](https://npmcn.com/package/%40api3/ois/.github/workflows/publish.yml) 将创建一个发布 PR.
4.  审查发行的 PR并合并到 `release` 使用 **壁画和合并**。 。 。 .
5.  这个 [发布动作工作流程](https://npmcn.com/package/%40api3/ois/.github/workflows/publish.yml) 将发布 GitHub 发布并发布软件包 npm与出处。 它还将建立一个公关,用于合并 `release` 树枝返回到 `main`。 。 。 .
6.  合并 PR 为 `main` 从 `release` **使用合并执行**。 。 。 .

请注意,发展可以继续下去 `main` 换言之, `main` 无需 保护.

## 常见问题

### @api3/ois 是什么？

OIS\(或作甲骨文集成规格\)是一个描述API规格的JSON对象

### 如何安装 @api3/ois？

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

### @api3/ois 支持 TypeScript 吗？

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

### @api3/ois 支持 ESM 还是 CommonJS？

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

### @api3/ois 可以商用吗？

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

### @api3/ois 的下载量有多少？

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

### @api3/ois 还在维护吗？

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