Skip to content

UnoAPI 自动化编码助手

基于 OpenAPI 规范自动生成前端 API 代码的 VS Code 扩展。

✨ 功能特性

🚀 一键生成 - 从 OpenAPI 文档自动生成 TypeScript API 代码
🔍 智能搜索 - 支持关键字搜索接口,快速定位需要的 API
📝 类型安全 - 自动生成 TypeScript 类型定义
🎯 灵活配置 - 支持自定义函数模板、类型映射等
📊 状态栏显示 - 实时显示配置状态,一键初始化

📦 安装

在 VS Code 扩展市场搜索 UnoAPI 或点击安装

🚀 快速开始

1. 初始化配置

点击状态栏的 ⚠ UnoAPI 或运行命令 UnoAPI: [init] 生成配置文件

2. 生成 API 代码

命令面板: Ctrl/Cmd + Shift + P → UnoAPI: [code] 生成 API 代码
右键菜单: 在文件或文件夹上右键 → UnoAPI: [code] 生成 API 代码
状态栏: 点击 ✓ UnoAPI

✨ 推荐使用右键菜单的方式，可在“当前目录或文件中”生成代码。

📝 配置说明

支持两种种配置方式:

package.json

{
  "unoapi": {
    "input": "https://api.example.com/openapi.json",
    "output": "src/api"
  }
}

unoapi.config.js

export default {
  input: 'https://api.example.com/openapi.json',
  output: 'src/api',
  typeMapping: {
    integer: 'number'
  }
}

❌ 扩展中不支持 unoapi.config.ts 的配置方式。

🎯 配置选项

选项	类型	默认值	说明
`input`	`string \\| Function`	-	OpenAPI 文档地址或本地路径
`output`	`string \\| [string, string]`	`src/api`	输出目录,数组表示 [API目录, Model目录]
`typeMapping`	`Record<string, string>`	内置默认	自定义类型映射
`funcTpl`	`Function`	内置默认	自定义函数模板
`imports`	`string \\| string[]`	-	API 文件头部导入代码
`onlyModel`	`boolean`	`false`	是否仅生成 Model
`ignore`	`(string \\| RegExp)[]`	-	忽略的接口

🎨 使用场景

场景 1: 生成单个接口

打开目标文件
右键 → UnoAPI: [code] 生成 API 代码
选择接口
代码自动追加到当前文件

场景 2: 生成到指定目录

在资源管理器中右键文件夹
选择 UnoAPI: [code] 生成 API 代码
选择接口
代码生成到选中的目录

场景 3: 仅生成 Model

运行命令 UnoAPI: [model] 生成 Model 代码
选择接口
只生成 TypeScript 类型定义

🔧 命令列表

命令	说明
`UnoAPI: [init] 生成配置文件`	初始化配置文件
`UnoAPI: [download] 下载 OpenAPI 文档`	下载并缓存 OpenAPI 文档
`UnoAPI: [code] 生成 API 代码`	生成 API 函数和类型
`UnoAPI: [model] 生成 Model 代码`	仅生成类型定义

📊 状态栏

✓ UnoAPI - 已配置,点击生成代码
⚠ UnoAPI - 未配置,点击初始化
⏳ UnoAPI - 正在加载文档

🤝 贡献

欢迎提交 Issue 和 Pull Request!

GitHub: moohng/unoapi
问题反馈: Issues

📄 许可证

MIT

🔗 相关链接

UnoAPI CLI - 命令行工具
UnoAPI Core - 核心库
OpenAPI 规范

Made with ❤️ by 前端星河