# @genapi/pipeline 中文文档

规范地址：https://npmcn.com/package/%40genapi/pipeline/

版本：4\.1\.4
npm 元数据更新时间：2026-07-29T09:33:21.074Z
中文译文更新时间：2026-11-16T02:46:31.331Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：25.6 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：8 个
- 首次发布：2023-05-05T06:35:41.014Z
- 最新版本发布：2026-07-29T09:33:20.752Z
- 近 30 天下载量：3728（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：27（近 12 个月 6 个）

## 中文简介

暂无中文简介

## 安装

```sh
npm install @genapi/pipeline
```

也可以使用：`pnpm add @genapi/pipeline`、`yarn add @genapi/pipeline`、`bun add @genapi/pipeline`

## README

# @ genapi/ 管道

[![npm version](https://img.shields.io/npm/v/@genapi/pipeline)](https://npmjs.com/package/@genapi/pipeline) [![npm downloads](https://img.shields.io/npm/dm/@genapi/pipeline)](https://npm.chart.dev/@genapi/pipeline)

GENAPI 管道核心:配置读取,数据源取取取,解析,编译,生成,和输出. 可用于自定义生成流 .

## 安装

```bash
pnpm add @genapi/pipeline
```

## API 密码

## 管道

### `compiler(configRead)`

将图表编译为代码字符串:每个输出的请求和打字.

**示例**

```ts
compiler(configRead)
configRead.outputs.forEach(o => console.log(o.code))
```

### `config(userConfig)`

将管道配置规范化:输出路径,响应Type,baseURL,并用输入/输出来构建配置.

**示例**

```ts
const configRead = config(defineConfig({ input: 'openapi.json', output: { main: 'src/api.ts' } }))
```

### `default(config, original, parser, compiler, generate, dest)`

由五个步骤构建GENAPI管道: 配置 → 原始 → 解析 → 编译 → 生成 → dest.

**示例**

```ts
const run = pipeline(config, original, parser, compiler, generate, dest)
await run(defineConfig({ input: 'openapi.json', output: { main: 'src/api.ts' } }))
```

### `dest(configRead)`

从配置Read.outputs(代码到路径)写入输出文件.

**示例**

```ts
await dest(configRead)
// Writes configRead.outputs[].code to configRead.outputs[].path
```

### `generate(configRead, options?)`

使用 Pretier 格式化每个输出的代码.

**示例**

```ts
await generate(configRead)
await generate(configRead, { printWidth: 100 })
```

### `original(configRead)`

获取來源:从配置Read. 输入并设置配置Read. source中解析 uri/http/json. 根据剖析器配置(wpapi - > swagger2, swagger - > 不变)来转换源. 支持YAML源 URL(例如:.yaml /.yml);使用收件箱进行解析(与Undoc相同).

**示例**

```ts
await original(configRead)
// configRead.source is set from uri/http/json; wpapi transformed to swagger2 if parser is 'wpapi'
```

### `formatTypescript(code, options?)`

格式化 TypeScript/JavaScript 代码字符串并带有 Pretier.

**示例**

```ts
const formatted = await formatTypescript('const x=1')
```

## 许可证

[麻省理工学院](https://github.com/hairyf/genapi/blob/main/LICENSE)

* * *

_自动更新 [自动](https://automd.unjs.io/)_

## 常见问题

### 如何安装 @genapi/pipeline？

在项目目录运行 npm install @genapi/pipeline，或使用 pnpm add / yarn add / bun add。

### @genapi/pipeline 支持 TypeScript 吗？

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

### @genapi/pipeline 支持 ESM 还是 CommonJS？

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

### @genapi/pipeline 可以商用吗？

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

### @genapi/pipeline 的下载量有多少？

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

### @genapi/pipeline 还在维护吗？

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

