# @basketry/openapi-3 中文文档

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

版本：0\.2\.4
npm 元数据更新时间：2025-08-23T19:40:52.356Z
中文译文更新时间：2026-11-07T22:30:36.079Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40basketry/openapi-3
原文对照：https://npmcn.com/package/%40basketry/openapi-3/?lang=original
项目主页：https://basketry.io/docs/components/@basketry/openapi-3
源码仓库：https://github.com/basketry/openapi-3

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

- 包体积（解压后）：805 kB，18 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：7 个
- 首次发布：2022-10-23T19:55:51.580Z
- 最新版本发布：2025-08-23T19:40:51.837Z
- 近 30 天下载量：2213（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：25（近 12 个月 0 个）

## 中文简介

OpenAPI 3.x 服务定义的篮子解析器

## 安装

```sh
npm install @basketry/openapi-3
```

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

## README

[![main](https://github.com/basketry/openapi-3/workflows/build/badge.svg?branch=main&event=push)](https://github.com/basketry/openapi-3/actions?query=workflow%3Abuild+branch%3Amain+event%3Apush) [![master](https://img.shields.io/npm/v/@basketry/openapi-3)](https://www.npmjs.com/package/@basketry/openapi-3)

# 打开API 3.x

[篮子分析器](https://github.com/basketry/basketry) 用于 OpenAPI 3.x 服务定义. 这个解析器可以与任何"篮子"生成器相配合,将一个OpenAPI 3.x文档翻译为其他文物,包括服务器,客户端,以及人可读文档.

## 快速启动

以下示例将 OpenAPI doc 转换为类型 :

1.  保存 `https://petstore.swagger.io/v2/swagger.json` 作为 `petstore.json` 在您的项目根.
2.  安装软件包 : `npm install -g basketry @basketry/openapi-3 @basketry/typescript`
3.  生成代码 : `basketry --source petstore.json --parser @basketry/openapi-3 --generators @basketry/typescript --output src`

当最后一步运行时,篮子会解析出源文件(`petstore.json`)使用指定的解析器(`@basketry/openapi-3`)然后运行每个指定的生成器(在此情况下) `@basketry/typescript`)写入输出文件夹(`src`) (中文(简体) ).

* * *

## 对于贡献者:

### 运行此工程

1.  安装软件包 : `npm ci`
2.  构建代码 : `npm run build`
3.  运行它! `npm start`

注意 `lint` 脚本运行于 `build`。可自动固定的起伏或格式化错误可以通过运行来修正 `npm run fix`。 。 。 .

### 创建和运行测试

1.  通过创建文件添加测试 `.test.ts` 后缀
2.  运行测试 : `npm t`
3.  测试覆盖率可在 `/coverage/lcov-report/index.html`

### 发布新软件包版本

1.  创建新版本
    1.  导航到 [版本工作流程](https://github.com/basketry/openapi-3/actions/workflows/version.yml) 从动作标签.
    2.  手动发送行动并附上适当的投入
    3.  这将创建一个带有新版本的 PR
2.  向国家预防机制公布
    1.  审查和合并公关
    2.  这个 [发布工作流程](https://github.com/basketry/openapi-3/actions/workflows/publish.yml) 将创建一个 git 标签并发布关于国家预防机制的软件包

* * *

创建于 [发电机控制台](https://www.npmjs.com/package/generator-ts-console)

## 常见问题

### @basketry/openapi-3 是什么？

OpenAPI 3\.x 服务定义的篮子解析器

### 如何安装 @basketry/openapi-3？

在项目目录运行 npm install @basketry/openapi-3，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 basketry-openapi-3，可以用 npx basketry-openapi-3 直接运行。

### @basketry/openapi-3 支持 TypeScript 吗？

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

### @basketry/openapi-3 支持 ESM 还是 CommonJS？

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

### @basketry/openapi-3 可以商用吗？

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

### @basketry/openapi-3 的下载量有多少？

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

### @basketry/openapi-3 还在维护吗？

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