# @gitbook/openapi-parser 中文文档

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

版本：3\.1\.0
npm 元数据更新时间：2026-11-10T17:29:04.512Z
中文译文更新时间：2026-11-16T10:41:27.051Z
软件包许可：未声明

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

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

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

- 包体积（解压后）：20.8 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2025-02-17T08:22:56.077Z
- 最新版本发布：2026-11-10T17:29:04.135Z
- 近 30 天下载量：6838（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：29（近 12 个月 9 个）

## 中文简介

在支持OpenAPI 3.1,OpenAPI 3.0和Swagger 2.0的情况下用TypeScript所写的现代OpenAPI parser.

## 安装

```sh
npm install @gitbook/openapi-parser
```

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

## README

# `@gitbook/openapi-parser`

在支持OpenAPI 3.1,OpenAPI 3.0和Swagger 2.0的情况下用TypeScript所写的现代OpenAPI parser.

## 常见问题

### @gitbook/openapi-parser 是什么？

在支持OpenAPI 3\.1,OpenAPI 3\.0和Swagger 2\.0的情况下用TypeScript所写的现代OpenAPI parser\.

### 如何安装 @gitbook/openapi-parser？

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

### @gitbook/openapi-parser 支持 TypeScript 吗？

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

### @gitbook/openapi-parser 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @gitbook/openapi-parser 可以商用吗？

@gitbook/openapi-parser 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @gitbook/openapi-parser 的下载量有多少？

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

### @gitbook/openapi-parser 还在维护吗？

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

