# @apielements/openapi3-parser 中文文档

规范地址：https://npmcn.com/package/%40apielements/openapi3-parser/

版本：0\.16\.1
npm 元数据更新时间：2022-06-28T21:36:08.786Z
中文译文更新时间：2026-11-06T10:00:21.194Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40apielements/openapi3-parser
原文对照：https://npmcn.com/package/%40apielements/openapi3-parser/?lang=original
项目主页：https://github.com/apiaryio/api-elements.js/tree/master/packages/fury-adapter-oas3-parser
源码仓库：https://github.com/apiaryio/api-elements.js

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

- 包体积（解压后）：166 kB，50 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=8
- 运行依赖：4 个
- peer 依赖：@apielements/core \>=0\.1\.0 \<0\.3\.0
- 首次发布：2020-04-30T08:16:28.041Z
- 最新版本发布：2021-07-15T16:24:59.938Z
- 近 30 天下载量：27982（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 0 个）

## 中文简介

打开 API 规格 3 API 元素解析器

## 安装

```sh
npm install @apielements/openapi3-parser
```

也可以使用：`pnpm add @apielements/openapi3-parser`、`yarn add @apielements/openapi3-parser`、`bun add @apielements/openapi3-parser`

## README

# API 元素: OpenAPI 3 解析器

## 当前状况

API 元素 [打开API](https://github.com/OAI/OpenAPI-Specification) 3 Parser 处于初期阶段,没有提供 完全支持 OpenAPI. 解析器会发出不支持的警告 函数。 你可以参考 [状态文档](https://github.com/apiaryio/api-elements.js/tree/master/packages/openapi3-parser/STATUS.md) 以检查当前状态 为每个功能提供支持.

## 使用量

安装 Fury 和 Open API 3 适配器,包括迷你.

```shell
$ npm install @apielements/openapi3-parser
```

```js
const { Fury } = require('fury');
const openapi3Adapter = require('@apielements/openapi3-parser');

// Add the OpenAPI 3 Adapter to Fury
fury.use(openapi3Adapter);

fury.parse({source: '... your OpenAPI 3 Document ...'}, (err, parseResult) => {
  console.log(parseResult.api.title);
});
```

读取 [API 要素联合材料:分析 结果](https://api-elements-js.readthedocs.io/en/latest/api.html#parse-result) 用于了解分析结果类型.

## 捐款

如果您正在尝试整合 OpenAPI 3 适配器或使用一个产品 使用 API 元素 然后我们欢迎您对适配器的任何反馈 在我们的问题跟踪器。 您可以在不支持的情况下找到打开的问题跟踪 功能,将支持下一个步骤。 对于 [1.0.0 里程碑](https://github.com/apiaryio/api-elements.js/milestone/1) 我们 将只专注于 OpenAPI 3 的初始支持 3个特征,需要一些设计思考和今后发布 [API 密码 要件](https://apielements.org/)。 。 。 .

我们把一些问题贴上了 "[不错的第一期](https://github.com/apiaryio/api-elements.js/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Aopenapi3+label%3A%22good+first+issue%22)" 表明他们 对于第一次贡献者来说,这些任务比较简单。 你们可以找到 解析器如何运作的信息和我们 [捐款 文档](https://github.com/apiaryio/api-elements.js/blob/master/packages/openapi3-parser/CONTRIBUTING.md)。 。 。 .

一定要检查一个 问题并非由他人指定来防止浪费精力.

## 常见问题

### @apielements/openapi3-parser 是什么？

打开 API 规格 3 API 元素解析器

### 如何安装 @apielements/openapi3-parser？

在项目目录运行 npm install @apielements/openapi3-parser，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@apielements/core（\>=0\.1\.0 \<0\.3\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @apielements/openapi3-parser 支持 TypeScript 吗？

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

### @apielements/openapi3-parser 支持 ESM 还是 CommonJS？

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

### @apielements/openapi3-parser 需要什么版本的 Node\.js？

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

### @apielements/openapi3-parser 可以商用吗？

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

### @apielements/openapi3-parser 的下载量有多少？

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

### @apielements/openapi3-parser 还在维护吗？

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