# @cabloy/openapi-typescript 中文文档

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

版本：7\.9\.2
npm 元数据更新时间：2025-10-04T13:07:29.568Z
中文译文更新时间：2026-11-08T23:10:38.109Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：824 kB，105 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：6 个
- peer 依赖：typescript ^5\.x
- 首次发布：2025-10-04T13:07:28.958Z
- 最新版本发布：2025-10-04T13:07:29.291Z
- 近 30 天下载量：5598（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

将 OpenAPI 3.0 & 3.1 计划转换为类型脚本

## 安装

```sh
npm install @cabloy/openapi-typescript
```

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

## README

![openapi-typescript](https://npmcn.com/package/docs/public/assets/openapi-ts.svg)

打开api-typescription 翻转 [OpenAPI 3.0 & 3.1](https://spec.openapis.org/oas/latest.html) 使用Node.js快速将图案切入TypeScript. 不需要Java/node-gyp/运行OpenAPI服务器.

代码是 [麻省理工学院执照](https://npmcn.com/package/%40cabloy/openapi-typescript/LICENSE) 免费使用.

> **提示 :** 新建到 OpenAPI 吗 ? Speeasy 的演讲 [输入到 OpenAPI](https://www.speakeasyapi.dev/openapi) 为新来者提供方便指南,解释OpenAPI的“为什么”和“如何”.

## 特征

-   • 支持OpenAPI 3.0和3.1(包括高级功能,例如 [歧视者](https://spec.openapis.org/oas/v3.1.0#discriminator-object)(中文(简体) )
-   生成 **无运行时间类型** 超越了老学校的密码
-   \* 本地或远程从YAML或JSON装入计划
-   \* 生成数以毫秒内甚至巨大的计划类型

_注意: OpenAPI 2. x 有版本支持 `5.x` 和以往_

## 实例

👀 [参见示例](https://npmcn.com/package/%40cabloy/openapi-typescript/examples/)

## 设置

此库需要最新的版本 [节点.js](https://nodejs.org/) 安装(建议20.x或更高)。 以此为契机,在您的项目中进行以下操作:

```bash
npm i -D openapi-typescript typescript
```

还有你的 `tsconfig.json`,以正确装入类型 :

```diff
{
  "compilerOptions": {
+    "module": "ESNext", // or "NodeNext"
+    "moduleResolution": "Bundler" // or "NodeNext"
  }
}
```

> **高度建议**
> 
> 此外,以下内容可增强类型安全性:
> 
> ```diff
> {
>   "compilerOptions": {
> +    "noUncheckedIndexedAccess": true
>   }
> }
> ```

## 基本用途

首先,通过运行生成本地类型文件 `npx openapi-typescript`首先指定您的输入方案( JSON 或 YAML) , 以及您喜欢的地方 `--output` (单位:千美元)`-o`待保存 :

```bash
# Local schema
npx openapi-typescript ./path/to/my/schema.yaml -o ./path/to/my/schema.d.ts
# 🚀 ./path/to/my/schema.yaml -> ./path/to/my/schema.d.ts [7ms]

# Remote schema
npx openapi-typescript https://myapi.dev/api/v1/openapi.yaml -o ./path/to/my/schema.d.ts
# 🚀 https://myapi.dev/api/v1/openapi.yaml -> ./path/to/my/schema.d.ts [250ms]
```

然后,在您的 TypeScript 项目中,在需要时导入类型 :

```ts
import type { paths, components } from "./my-openapi-3-schema"; // generated by openapi-typescript

// Schema Obj
type MyType = components["schemas"]["MyType"];

// Path params
type EndpointParams = paths["/my/endpoint"]["parameters"];

// Response obj
type SuccessResponse =
  paths["/my/endpoint"]["get"]["responses"][200]["content"]["application/json"]["schema"];
type ErrorResponse =
  paths["/my/endpoint"]["get"]["responses"][500]["content"]["application/json"]["schema"];
```

从这里,您可以将这些类型用于以下任何一种(但不限于):

-   使用 OpenAPI 支持的获取客户端( 如 [openapi 牵引](https://openapi-ts.dev/openapi-fetch/)(中文(简体) )
-   用于其他 API 请求的搜索类型
-   基于 API 类型构建核心业务逻辑
-   校验模拟测试数据符合当前计划
-   将 API 类型装入您发布的任何 npm 包( 如客户端 SDKs等)

## 医生

[查看 Docs](https://openapi-ts.dev/)

## 常见问题

### @cabloy/openapi-typescript 是什么？

将 OpenAPI 3\.0 & 3\.1 计划转换为类型脚本

### 如何安装 @cabloy/openapi-typescript？

在项目目录运行 npm install @cabloy/openapi-typescript，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：typescript（^5\.x）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 openapi-typescript，可以用 npx openapi-typescript 直接运行。

### @cabloy/openapi-typescript 支持 TypeScript 吗？

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

### @cabloy/openapi-typescript 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @cabloy/openapi-typescript 可以商用吗？

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

### @cabloy/openapi-typescript 的下载量有多少？

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

### @cabloy/openapi-typescript 还在维护吗？

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