AutoAPIGen-Vsix

简介

AutoAPIGen 是一个用于自动生成 API 代码的 VSCode 插件。它通过解析项目中的 API 配置，生成相应的 TypeScript 接口和函数代码，帮助开发者快速构建 API 层。

功能

• 自动生成 API 函数和接口：根据项目配置自动生成 API 函数和接口定义，一键解放枯燥的 API 编写和接口类型定义工作。（V1.0版本只集成了apifiox的自动导入功能）
• 支持多种 API 模型：支持 axios、vueUse、VueHookPlus、wx 和自定义模型。(V1.0版本只做了axios和自定义)
• 代码格式化：集成 Prettier 和 ESLint，确保生成的代码符合项目的代码风格。
• 界面化配置：通过配置页面，可以方便地配置 API 模型、请求头、路径等信息。
• 自定义模板：支持自定义模板，用户可以根据自己的需求定义生成代码的模板。
• 自动引入：自动引入生成的代码，在需要的页面直接生成接口引用。
• 详细的日志：插件的运行日志会记录在 VSCode 的输出面板中，方便用户查看和调试。

安装

1. 打开 VSCode。
2. 进入扩展市场，搜索 AutoAPIGen。
3. 点击安装按钮进行安装。

使用方法

1. 打开一个包含 API 配置的项目。
2. 在命令面板中输入 AutoAPIGen: Show Config Page 打开配置页面。
3. 根据需要调整配置，点击保存。
4. 在命令面板中输入 AutoAPIGen: Generate API Files 生成 API 文件。

配置

插件的配置文件位于项目的 .vscode/autoApiGen.json 中，用户可以在配置文件中设置 API 模型、请求头、路径等信息。

常见问题

• 生成失败：请检查配置文件是否正确，确保所有必需的字段都已填写。
• 代码格式化错误：请检查 Prettier 和 ESLint 的配置，确保它们能够正常工作。

贡献

欢迎对本项目进行贡献！您可以通过提交 Pull Request 或报告 Issue 的方式参与到项目中。

许可证

本项目采用 MIT 许可证。