# @apidevtools/openapi-schemas 中文文档

规范地址：https://npmcn.com/package/%40apidevtools/openapi-schemas/

版本：2\.1\.0
npm 元数据更新时间：2026-01-24T16:02:50.602Z
中文译文更新时间：2026-11-06T09:59:50.214Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：189 kB，34 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=10
- 运行依赖：0 个
- 首次发布：2020-03-10T12:01:32.612Z
- 最新版本发布：2021-05-01T15:46:34.289Z
- 近 30 天下载量：22458301（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

每个版本的 OpenAPI 规格的 JSON Schemas

## 安装

```sh
npm install @apidevtools/openapi-schemas
```

也可以使用：`pnpm add @apidevtools/openapi-schemas`、`yarn add @apidevtools/openapi-schemas`、`bun add @apidevtools/openapi-schemas`

## README

# OpenAPI 规格图

[![Cross-Platform Compatibility](https://apitools.dev/img/badges/os-badges.svg)](https://github.com/APIDevTools/openapi-schemas/actions) [![Build Status](https://github.com/APIDevTools/openapi-schemas/workflows/CI-CD/badge.svg?branch=master)](https://github.com/APIDevTools/openapi-schemas/actions)

[![Coverage Status](https://coveralls.io/repos/github/APIDevTools/openapi-schemas/badge.svg?branch=master)](https://coveralls.io/github/APIDevTools/openapi-schemas) [![Dependencies](https://david-dm.org/APIDevTools/openapi-schemas.svg)](https://david-dm.org/APIDevTools/openapi-schemas)

[![npm](https://img.shields.io/npm/v/@apidevtools/openapi-schemas.svg)](https://www.npmjs.com/package/@apidevtools/openapi-schemas) [![License](https://img.shields.io/npm/l/@apidevtools/openapi-schemas.svg)](https://npmcn.com/package/%40apidevtools/openapi-schemas/LICENSE) [![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen)](https://plant.treeware.earth/APIDevTools/openapi-schemas)

此软件包包含 [**jSON Schemas官方网站**](https://github.com/OAI/OpenAPI-Specification/tree/master/schemas) 每个版本的 Swagger/ OpenAPI 规格 :

| 版本 | 司马 | 文档 |
| --- | --- | --- |
| 交换机 1.2 | [v1.2 计划](https://github.com/OAI/OpenAPI-Specification/tree/master/schemas/v1.2) | [v1.2 文档](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/1.2.md) |
| 斯瓦格2.0 | [v2.0 计划](https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v2.0/schema.json) | [v2.0 文档](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) |
| OpenAPI 3.0.x 打开API 3.0.x | [v3.0.x 计划](https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v3.0/schema.json) | [v3.0.3 文档](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md) |
| OpenAPI 3.1.x (英语) | [v3.1.x 计划](https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v3.1/schema.json) | [v3.1.0 文档](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md) |

所有计划都通过自动化的CI/CD工作不断更新最新的官方定义. 🤖📦

## 安装

您可以通过 OpenAPI Schemas 安装 [无](https://docs.npmjs.com/about-npm/)。 。 。 .

```bash
npm install @apidevtools/openapi-schemas
```

## 使用量

默认导出包含所有 OpenAPI 规格版本 :

```javascript
const openapi = require("@apidevtools/openapi-schemas");

console.log(openapi.v1);    // { $schema, id, properties, definitions, ... }
console.log(openapi.v2);    // { $schema, id, properties, definitions, ... }
console.log(openapi.v3);    // { $schema, id, properties, definitions, ... }
console.log(openapi.v31);    // { $schema, id, properties, definitions, ... }
```

或者可以导入所需的特定版本 :

```javascript
const { openapiV1, openapiV2, openapiV3, openapiV31 } = require("@apidevtools/openapi-schemas");

console.log(openapiV1);    // { $schema, id, properties, definitions, ... }
console.log(openapiV2);    // { $schema, id, properties, definitions, ... }
console.log(openapiV3);    // { $schema, id, properties, definitions, ... }
console.log(openapiV31);    // { $schema, id, properties, definitions, ... }
```

您可以使用 JSON Schema 验证器, 如 [Z- 计划](https://www.npmjs.com/package/z-schema) 或者说 [阿联酋](https://www.npmjs.com/package/ajv) 根据规格验证 OpenAPI 定义.

```javascript
const { openapiV31 } = require("@apidevtools/openapi-schemas");
const ZSchema = require("z-schema");

// Create a ZSchema validator
let validator = new ZSchema();

// Validate an OpenAPI definition against the OpenAPI v3.0 specification
validator.validate(openapiDefinition, openapiV31);
```

## 捐款

欢迎贡献、增强和错误修正! [打开一个问题](https://github.com/APIDevTools/openapi-schemas/issues) 关于 GitHub 和 [提交拉动请求](https://github.com/APIDevTools/openapi-schemas/pulls)。 。 。 .

#### 大楼

要在您的计算机上本地构建工程:

1.  **克隆这个还原**  
    `git clone https://github.com/APIDevTools/openapi-schemas.git`
    
2.  **安装依赖关系**  
    `npm install`
    
3.  **构建代码**  
    `npm run build`
    
4.  **运行测试**  
    `npm test`
    

## 许可证

OpenAPI Schemas 是100%的自由和开放源代码, 在 [麻省理工学院许可证](https://npmcn.com/package/%40apidevtools/openapi-schemas/LICENSE)随意使用.

这个软件包是 [树件](http://treeware.earth/)如果你把它用于生产,那么我们要求你 [**给世界买一棵树**](https://plant.treeware.earth/APIDevTools/openapi-schemas) 感谢我们的工作。 将会为当地家庭创造就业机会.

## 谢谢

感谢这些优秀的公司对开源开发商的支持 QQ

[![GitHub](https://apitools.dev/img/badges/github.svg)](https://github.com/open-source) [![NPM](https://apitools.dev/img/badges/npm.svg)](https://www.npmjs.com/) [![Coveralls](https://apitools.dev/img/badges/coveralls.svg)](https://coveralls.io/) [![Travis CI](https://apitools.dev/img/badges/travis-ci.svg)](https://travis-ci.com/) [![SauceLabs](https://apitools.dev/img/badges/sauce-labs.svg)](https://saucelabs.com/)

## 常见问题

### @apidevtools/openapi-schemas 是什么？

每个版本的 OpenAPI 规格的 JSON Schemas

### 如何安装 @apidevtools/openapi-schemas？

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

### @apidevtools/openapi-schemas 支持 TypeScript 吗？

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

### @apidevtools/openapi-schemas 支持 ESM 还是 CommonJS？

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

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

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

### @apidevtools/openapi-schemas 可以商用吗？

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

### @apidevtools/openapi-schemas 的下载量有多少？

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

### @apidevtools/openapi-schemas 还在维护吗？

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