@genapi/transform

中文文档
4.1.4发布于 2026/07/29MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 3595
中文使用文档
文档目录12 节
  1. 安装
  2. API 密码
  3. 变形
  4. swagger2ToSwagger3(source)
  5. wpapiToSwagger2(source)
  6. buildParam(name, method, endpoint, detail)
  7. convertEndpoint(endpoint)
  8. default
  9. 变形
  10. getParametersFromArgs(endpoint, args, method)
  11. getParametersFromEndpoint(endpoint)
  12. 许可证

@ genapi/ 转换

npm version npm downloads

Spec transform: Swagger 2 QQ OpenAPI 3, WordPress REST API → Swagger 2等,因此解析器工作采用统一格式.

安装

pnpm add @genapi/transform

API 密码

变形

swagger2ToSwagger3(source)

将 OpenAPI 3.x 规范为类似 Swagger 2 的形状(host, basePath, 方案, 定义来自组件. schemas) 。 用 Swagger 2( 基于工具) 进行突变并返回相同的对象 .

示例

const swagger2Like = swagger2ToSwagger3(openApi3Spec)
// swagger2Like.host, basePath, definitions, schemes set from servers/components

wpapiToSwagger2(source)

将 WordPress REST API 计划转换为 Swagger 2.0 格式.

示例

const swagger = wpapiToSwagger2({ routes: { '/wp/v2': { namespace: 'wp/v2', endpoints: [...] } } })
// Use with parser or pipeline as OpenAPI 2.0 input

buildParam(name, method, endpoint, detail)

从 WordPress 参数定义中构建一个单一的 OpenAPI 参数.

示例

buildParam('id', 'GET', '/posts/{id}', { type: 'integer' }) // { name: 'id', in: 'path', type: 'integer', ... }

convertEndpoint(endpoint)

自动失效

将 WordPress 风格的路径模式转换为 Swagger 路径格式.

示例

convertEndpoint('/wp/v2/posts/(?P<id>[\\d]+)') // '/wp/v2/posts/{id}'

default

变形

swagger2ToSwagger3(source)

将 OpenAPI 3.x 规范为类似 Swagger 2 的形状(host, basePath, 方案, 定义来自组件. schemas) 。 用 Swagger 2( 基于工具) 进行突变并返回相同的对象 .

示例

const swagger2Like = swagger2ToSwagger3(openApi3Spec)
// swagger2Like.host, basePath, definitions, schemes set from servers/components

wpapiToSwagger2(source)

将 WordPress REST API 计划转换为 Swagger 2.0 格式.

示例

const swagger = wpapiToSwagger2({ routes: { '/wp/v2': { namespace: 'wp/v2', endpoints: [...] } } })
// Use with parser or pipeline as OpenAPI 2.0 input

getParametersFromArgs(endpoint, args, method)

从 WordPress 端点参数构建 OpenAPI 参数.

示例

getParametersFromArgs('/posts/{id}', { id: { type: 'integer' } }, 'GET')

getParametersFromEndpoint(endpoint)

从 WordPress 风格的端点模式中提取路径参数.

示例

getParametersFromEndpoint('/posts/(?P<id>[\\d]+)') // [{ name: 'id', in: 'path', type: 'integer', required: true }]

许可证

麻省理工学院


自动更新 自动

版本与发布记录

@genapi/transform 共发布 19 个版本,首次发布于 2025/03/28;过去 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/transform 的常见问题

如何安装 @genapi/transform?

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

@genapi/transform 支持 TypeScript 吗?

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

@genapi/transform 支持 ESM 还是 CommonJS?

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

@genapi/transform 可以商用吗?

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

@genapi/transform 的下载量有多少?

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

@genapi/transform 还在维护吗?

最新版本 4.1.4 发布于 2026/07/29(3 个月前);至今共发布 19 个版本,其中过去 12 个月发布了 6 个;首次发布于 2025/03/28。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。