@ genapi/ 管道
GENAPI 管道核心:配置读取,数据源取取取,解析,编译,生成,和输出. 可用于自定义生成流 .
安装
pnpm add @genapi/pipeline
API 密码
管道
compiler(configRead)
将图表编译为代码字符串:每个输出的请求和打字.
示例
compiler(configRead)
configRead.outputs.forEach(o => console.log(o.code))
config(userConfig)
将管道配置规范化:输出路径,响应Type,baseURL,并用输入/输出来构建配置.
示例
const configRead = config(defineConfig({ input: 'openapi.json', output: { main: 'src/api.ts' } }))
default(config, original, parser, compiler, generate, dest)
由五个步骤构建GENAPI管道: 配置 → 原始 → 解析 → 编译 → 生成 → dest.
示例
const run = pipeline(config, original, parser, compiler, generate, dest)
await run(defineConfig({ input: 'openapi.json', output: { main: 'src/api.ts' } }))
dest(configRead)
从配置Read.outputs(代码到路径)写入输出文件.
示例
await dest(configRead)
// Writes configRead.outputs[].code to configRead.outputs[].path
generate(configRead, options?)
使用 Pretier 格式化每个输出的代码.
示例
await generate(configRead)
await generate(configRead, { printWidth: 100 })
original(configRead)
获取來源:从配置Read. 输入并设置配置Read. source中解析 uri/http/json. 根据剖析器配置(wpapi - > swagger2, swagger - > 不变)来转换源. 支持YAML源 URL(例如:.yaml /.yml);使用收件箱进行解析(与Undoc相同).
示例
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.
示例
const formatted = await formatTypescript('const x=1')
许可证
自动更新 自动