@ genapi/ 核心
用于从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()
许可证
自动更新 自动