# Alova OpenAPI 集成 > 客户端使用请参见`alova-client`技能。对于服务器端（Node/Bun/Deno），请参阅 `alova-server` 技能。 Alova 通过“@alova/wormhole”与 OpenAPI/Swagger 规范集成，以自动生成 API 请求函数和 TypeScript 类型。 ## 工作流程安装 → 创建 alova.config → 运行 alova gen → 自定义 alova 实例 → 使用生成的 API ## Alova 配置 ### 配置文件支持的格式： * `alova.config.cjs`: CommonJS 配置文件 * `alova.config.js`: ESModule配置文件 * `alova.config.ts`：TypeScript 配置文件使用 alova init 命令快速创建配置模板。从'@alova/wormhole'导入{defineConfig}；导出默认的defineConfig({ // API生成设置数组发电机：[ { // OpenAPI 文件 URL 或本地路径输入：'http://localhost:3000/openapi.json', // 输出路径输出：'src/api', // 平台类型（swagger）平台：“招摇”， // 插件配置插件：[]， // 响应数据媒体类型（默认：application/json）响应媒体类型：'应用程序/json'， // 请求正文媒体类型（默认：application/json） bodyMediaType: '应用程序/json', // API 版本（默认：自动）版本：'自动'， // 代码类型：auto/ts/typescript/module/commonjs 类型：'自动'， // 全局API导出名称（默认：Apis）全局：“API”， // 全局挂载对象（默认：globalThis） globalHost: 'globalThis', // 过滤/转换API接口函数 handleApi: (apiDescriptor) => apiDescriptor, }, ], // 自动更新配置 autoUpdate: true, // 或 { launchEditor: true, Interval: 5 * 60 * 1000 } }); > `defineConfig` 还可以接受同步或异步函数，以允许更动态的配置。 ### 预设虫洞插件插件 |描述 |文档 ---|---|--- `重命名` |重命名API函数和参数名称，支持camelCase/snake_case | [文档]() `标签修改器` |修改API标签名称 | [文档]() `有效负载修改器` |添加/删除/修改API参数类型 | [文档]() `filterApi` |按 URL 和标签匹配过滤 API | [文档]() `apifox` |自动导入 Apifox 项目 | [文档]() `导入类型` |排除需要定制的类型 | [文档]() **使用示例**：从“@alova/wormhole/plugin”导入{重命名，tagModifier}；导出默认的defineConfig({ 发电机：[ { 插件：[ 重命名({ 样式: '驼峰式' }), 标签修改器({ ... }) ] } ] }); ###handleApi 钩子用于自定义API配置。在生成每个 API 之前调用。可以修改参数名称、类型或返回类型。 **注意**：`apiDescriptor` 参数包含 OpenAPI 文件中每个 API 的信息。有关详细信息，请参阅[OpenAPI 规范操作对象]()。 **重命名函数（snake_case→camelCase）**： handleApi: (apiDescriptor) => { apiDescriptor.operationId = apiDescriptor.operationId.replace(/_([a-z])/g, (匹配, 组) => group.toUpperCase() ）；返回 apiDescriptor； }; **修改标签**： handleApi: (apiDescriptor) => { if (apiDescriptor.url.includes('/user')) { apiDescriptor.tags = ['userTag']; } 返回 apiDescriptor； }; **过滤API**： handleApi: (apiDescriptor) => { // 返回 false 值来过滤此 API if (!apiDescriptor.path.startsWith('/user')) { 返回； } 返回 apiDescriptor； }; **修改响应数据类型生成**： handleApi: (apiDescriptor) => { apiDescriptor.responses = apiDescriptor.responses?.properties?.data; 返回 apiDescriptor； }; **更喜欢使用 Wormhole 插件**而不是 `handleApi` 来修改生成的数据。插件简化了逻辑并按配置顺序执行。 ## 功能和参考文档特色|参考 ---|--- 安装和设置| [参考文献/安装]() CLI 用法（`alova gen`、`alova init`）| [参考文献/CLI]() 编程 API（“生成”、“读取配置”）| [参考文献/PROGRAMMATIC-API]() 自定义 alova 实例 (`index.ts`) | [参考文献/ALOVA-INSTANCE]() 故障排除 | [参考文献/故障排除]()

Alova 虫洞用途

包含技能