@genapi/core

中文文档
4.1.4发布于 2026/07/29MITTypeScriptES Module构建来源已验证近 30 天下载 3432
中文使用文档
文档目录14 节
  1. 安装
  2. 使用量
  3. API 密码
  4. 核心
  5. generate(config)
  6. 弹出
  7. inject(scope)
  8. absolutePath(_path)
  9. ApiPipeline
  10. context
  11. defineConfig(config)
  12. inPipeline(pipe)
  13. provide()
  14. 许可证

@ genapi/ 核心

npm version npm downloads

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

安装

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

使用量

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

API 密码

核心

generate(config)

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

示例

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

弹出

inject(scope)

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

示例

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

absolutePath(_path)

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

示例

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 相会.

示例

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},然后是本地路径 .

示例

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

provide()

许可证

麻省理工学院


自动更新 自动

版本与发布记录

@genapi/core 共发布 27 个版本,首次发布于 2023/05/05;过去 12 个月发布了 6 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
4.1.4latest2026/07/293 个月前
4.1.32026/07/233 个月前
4.1.22026/07/233 个月前
4.1.12026/05/215 个月前
4.1.02026/02/099 个月前
4.0.02026/02/099 个月前

关于 @genapi/core 的常见问题

如何安装 @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 和提交记录判断。