Skip to content

AutoAPIGen

一键生成 API 请求代码和 TypeScript 类型定义

告别手写 API 代码,让开发效率提升 300%,专注于业务逻辑

🎬 功能演示


📊 为什么选择 AutoAPIGen?

维度传统手写方式使用 AutoAPIGen提升幅度
⚙️ 单个接口生成时间5-10 分钟10-20 秒减少 95%
⚠️ 类型错误率10-20%< 1%降低 95%
🎨 代码风格统一度60-70%100%提升 40%
🔄 文档同步效率人工对比一键重新生成效率提升10倍

✨ 主要特性

🔌 对接 Apifox API 文档

    • 📋 多项目管理 - 快速查看 API 列表,支持多个项目并行管理
    • 🔍 智能搜索 - 高效搜索和定位 API,支持模糊匹配
    • 🔄 灵活切换 - 快速切换不同项目,无缝工作流
    • 🔐 Cookie 认证 - 支持最新版 Apifox 的 Cookie 认证方式

⚙️ 灵活的自定义配置

    • 📁 目录配置 - 自由配置生成目录和目标项目
    • 📦 多模板支持 - 提供 Axios、微信小程序等内置模板
    • 🎨 自定义模板 - 支持自定义接口返回模板和拓展函数
    • 💅 Prettier 集成 - 自定义格式化规则,自动格式化生成代码
    • 🔧 Axios 引用路径 - 自定义 Axios 引用路径,适配项目结构

🚀 优化的开发体验

    • ✍️ 自动代码生成 - 无需手写接口请求代码和 TS 类型定义
    • 👥 团队协作 - 统一团队接口风格,减少沟通成本
    • 🛡️ 类型安全 - 自动生成类型安全的接口请求代码,提高代码质量
    • 📖 可视化详情 - 接口详情页展示参数、响应结构,一目了然
    • 一键插入 - 直接将接口引用代码插入到当前编辑窗口
    • 🔍 快速定位 - 从接口详情页直接跳转到生成的代码文件

💻 技术特性

🔐 类型安全

  • 完整的 TypeScript 支持 - 请求参数类型检查,响应数据类型推导
  • IDE 智能提示 - 完整的类型定义,开发更高效
  • 编译时错误检测 - 提前发现问题,减少运行时错误

🎨 代码质量

  • Prettier 自动格式化 - 生成的代码风格统一,符合团队规范
  • ESLint 兼容 - 支持 ESLint 规则,保证代码质量
  • 注释完整 - 自动生成接口注释,代码可读性强

⚡ 性能优化

  • 按需加载 Monaco Editor - 轻量级打包,< 2MB
  • 智能缓存 - 接口数据缓存,减少网络请求
  • 异步生成 - 不阻塞编辑器,使用体验流畅

🚀 快速开始

1️⃣ 安装插件

在 VS Code 扩展商店搜索 "AutoAPIGen" 并安装,或者使用命令行:

bash
code --install-extension script.AutoAPIGen

2️⃣ 配置认证

  1. 登录 Apifox
  2. F12 打开开发者工具
  3. Network 面板中复制任意请求的 Cookie
  4. 在插件中粘贴 Cookie 配置

3️⃣ 开始使用

  1. 选择目标项目
  2. 配置生成路径
  3. 点击接口列表中的接口
  4. 点击“生成接口代码”
  5. ✅ 完成!

详细教程请查看 快速开始指南

🎓 适用场景

✅ TypeScript 项目

完美支持 TypeScript,提供完整的类型定义和智能提示。

✅ 现代前端框架

支持 React、Vue、Angular 等主流框架,内置 Axios 模板。

✅ 微信小程序

提供 wx.request 封装模板,快速开发小程序项目。

✅ 团队协作

统一代码风格,提升团队开发效率和协作质量。

✅ Apifox 用户

无缝对接 Apifox 平台,自动同步文档更新。

✅ 个人开发者

提升个人开发效率,专注于业务逻辑实现。

🌟 开源与社区

AutoAPIGen 是一个完全开源的项目,采用 MIT 开源协议,欢迎社区贡献!

👥 如何贡献

📊 项目统计

GitHub starsGitHub forksGitHub issuesVS Code DownloadsVS Code Rating

🔗 相关链接

基于 MIT 许可发布