FAQ 常见问题解答
以下是使用 AutoAPIGen 插件时的常见问题和解决方案，帮助您更高效地使用插件。
1. 如何安装 AutoAPIGen 插件？
问题：如何在 VSCode 或 Cursor 中安装插件？
解决方案：
在 VSCode 或 Cursor 中，您可以通过扩展商店搜索 autoAPIGenDoc 并安装插件，或从 GitHub 下载 .vsix 文件并手动安装。详细安装步骤请参考 安装指南。
2. 为什么无法获取项目列表？
问题：点击 获取项目列表 按钮后未显示项目？
解决方案：
请确认以下几点：
- 已正确配置
Authorization值。获取方法：登录 Apifox，通过浏览器开发者工具获取请求头中的Authorization字段值。 - 网络状态正常且 API 文档配置无误。
3. 接口生成失败怎么办？
问题：生成接口代码时出现失败提示？
解决方案：
- 确保目标目录存在，或由插件自动创建新目录。
- 检查接口文档配置完整性，确保所有路径、方法及参数均正确。
- 如果使用了自定义配置，请确保模板字符串逻辑正确无误。
4. 如何使用 options 参数自定义接口？
问题：我需要自定义接口返回的模型，如何配置？
解决方案： 通过 options 参数自定义接口返回模型，以下是主要字段说明：
pathParams：路径参数配置。queryParams：查询参数配置。apiMethod：请求方法（如GET、POST）。 详细字段说明请参考 options 参数文档。
5. 自定义 axios 封装时需要注意什么？
问题：如何实现自定义 axios 封装？
解决方案：
- 在自定义代码中，使用
options提供的参数来构建模板字符串。 - 避免直接定义接口方法名，需使用
options.apiFunctionName和options.extraFunctionName。 - 可通过
options.log方法输出调试信息。详细示例请参考 高级选项文档。
6. 为什么生成的代码没有格式化？
问题：生成的接口代码未自动格式化？
解决方案：
AutoAPIGen 内置了 prettier 插件，会对生成代码进行格式化。如果格式化未生效：
- 检查项目中是否有冲突的
prettier配置。 - 手动运行格式化工具对生成文件进行处理。更多配置请参考 基本设置。
7. 是否支持自定义返回数据结构？
问题：接口返回的数据结构与默认模板不一致，如何调整？
解决方案：
可以通过自定义 axios 封装来调整返回数据结构。需要在自定义模板中实现数据格式转换逻辑，确保符合项目需求。
8. 为什么接口请求没有返回数据？
问题：调用生成的接口请求方法时没有返回数据？
解决方案：
- 检查接口返回的数据结构是否与
axios二次封装一致。 - 确保
options.apiReturnType对应正确的 TypeScript 类型。 - 确认接口路径和参数配置正确。
9. 如何快速定位接口方法？
问题：如何快速查找并查看生成的接口方法？
解决方案：
在插件的接口列表中，点击 查看接口方法 按钮，插件会自动打开对应的代码文件并定位到该接口方法。
10. 插件是否支持其他文档管理平台？
问题：目前仅支持 Apifox，后续是否支持其他平台？
解决方案：
目前仅支持 Apifox，后续计划支持 Postman 和 ApiPost 等文档管理平台，请关注插件的更新动态。
通过以上常见问题解答，您可以轻松解决大部分使用中的问题。如果仍无法解决，请参考相关文档或联系插件维护者。