# @genapi/core 中文文档

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

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

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

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

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

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

## 中文简介

暂无中文简介

## 安装

```sh
npm install @genapi/core
```

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

## README

# @ genapi/ 核心

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

用于从OpenAPI/Swagger和其他输入生成TypeScript/JavaScript API代码的 CLI和配置条目.

## 安装

```bash
pnpm add -D @genapi/core @genapi/presets
```

## 使用量

创建 `genapi.config.ts` 或者说 `genapi.config.js` 在您的工程根中,然后运行 `genapi` 命令.

## API 密码

## 核心

### `generate(config)`

运行一个或多个配置的 GENAPI 管道。 按名称决定管道(例如:. `swag-axios-ts`),然后运行配置 = 原件 = parser = 编译器 = 生成 = dest.

**示例**

```ts
await generate(defineConfig({ preset: 'swag-axios-ts', input: 'openapi.json', output: { main: 'src/api.ts' } }))
await generate([config1, config2])
```

## 弹出

### `inject(scope)`

获取给定范围的当前管道上下文( 默认 ): `'default'`) (中文(简体) ). 用于在管道步骤内读取配置/图.

**示例**

```ts
const { configRead, interfaces } = inject()
const config = inject('get/user/1')
```

### `absolutePath(_path)`

确定一条通往绝对路径的路径;相对路径通过cwd()解决.

**示例**

```ts
absolutePath('./presets/axios') // path.resolve(cwd(), './presets/axios')
absolutePath('/etc/config') // '/etc/config'
```

### `ApiPipeline`

-   **类型**数字 : `undefined`
-   **默认**数字 : `undefined`

### `context`

-   **类型**数字 : `any`
-   **默认**数字 : `{}`

### `defineConfig(config)`

定义 GenAPI 配置 `genapi.config.ts` 编号 : `genapi.config.js`支持单一服务配置或多种服务 `servers` 相会.

**示例**

```ts
export default defineConfig({
  preset: axios.ts,
  input: 'https://petstore3.swagger.io/api/v3/openapi.json',
  output: { main: 'src/api/index.ts', type: 'src/api/index.type.ts' },
})
```

### `inPipeline(pipe)`

从预设的名称或函数解析一个管道。 tries @ genapi/ presets/{name}, genapi-{name},然后是本地路径 .

**示例**

```ts
const pipeline = await inPipeline('swag-axios-ts')
await pipeline(config)
```

### `provide()`

## 许可证

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

* * *

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

## 常见问题

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

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

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

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

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

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

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

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

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

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

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

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

