UnoAPI - 前端 API 自动化代码生成解决方案
UnoAPI 是一个基于 OpenAPI (Swagger) 规范的现代化前端代码生成工具集。它旨在通过自动化流程,消除繁琐的手动 API 定义工作,提供类型安全、高度可定制的开发体验。
🌟 核心特性
🚀 自动化
一键从 OpenAPI 文档生成 TypeScript 接口和 API 请求函数,告别手动编写重复代码。
🛡️ 类型安全
自动生成完整的 TypeScript 类型定义,在编译时就能发现潜在问题,减少运行时错误。
🧩 模块化设计
采用 Monorepo 架构,提供 Core SDK、CLI 工具和 VS Code 扩展,满足不同场景需求。
🎨 高度定制
支持自定义模板、类型映射和生成规则,可以根据项目需求灵活配置。
🔌 多平台支持
无论你喜欢命令行还是 IDE 插件,都能找到适合你的工具。
📦 生态系统
UnoAPI 由以下几个核心包组成:
@unoapi/core
核心 SDK,提供代码生成的核心功能和 API。
@unoapi/cli
命令行工具,支持在终端中快速生成代码。
VS Code 扩展
集成到 VS Code 的扩展,提供可视化操作界面。
🚀 快速开始
使用命令行工具 (推荐)
bash
# 全局安装
npm install -g @unoapi/cli
# 创建配置文件
uno init
# 生成 API 代码
uno api使用 VS Code 扩展
- 在 VS Code 扩展市场搜索 "unoapi" 并安装
- 在项目中运行命令
UnoAPI: [init]生成配置文件 - 打开
.ts文件,右键选择UnoAPI: [code]生成 API 代码
💡 使用场景
前后端分离项目
后端提供 OpenAPI 文档,前端使用 UnoAPI 自动生成类型安全的 API 调用代码。
微服务架构
多个服务的 API 文档可以统一管理,一键生成所有服务的前端调用代码。
团队协作
统一的代码生成规则,确保团队成员使用一致的 API 调用方式。
🛠️ 技术栈
- TypeScript - 提供完整的类型支持
- OpenAPI 3.0 - 基于业界标准的 API 规范
- Monorepo - 使用 pnpm workspace 管理多包项目
- Vite - 现代化的构建工具
📊 项目数据
- ⭐ GitHub Stars: 持续增长中
- 📦 NPM 下载量: 稳定增长
- 🔄 版本更新: 32+ 个版本迭代
- 👥 贡献者: 2+ 位开发者
🔗 相关链接
📝 开发动机
在前端开发中,我们经常需要根据后端 API 文档手动编写接口定义和请求函数。这个过程不仅繁琐,还容易出错。UnoAPI 的诞生就是为了解决这个痛点,让开发者可以专注于业务逻辑,而不是重复的体力劳动。
🎯 未来规划
- 支持更多的请求库(axios、fetch、ky 等)
- 提供更丰富的模板系统
- 支持 GraphQL 等其他 API 规范
- 完善文档和示例
📄 许可证
MIT License - 自由使用,欢迎贡献!
如果你觉得 UnoAPI 对你有帮助,欢迎在 GitHub 上给个 Star ⭐