IDE Plugin FAQ-ApiHug - API design Copilot

🤗 ApiHug × {Postman|Swagger|Api...} = 快↑ 准√ 省↓

GitHub - apihug/apihug.com: All abou the Apihug apihug.com: 有爱，有温度，有质量，有信任 ApiHug - API design Copilot - IntelliJ IDEs Plugin | Marketplace

docs/IDE/999_FAQ.md · dearxuecom/apihug.com - Gitee.comhttps://gitee.com/dearxuecom/apihug.com/blob/master/docs/IDE/999_FAQ.md

ProtoBuf

Proto 文件不能识别, can not recognize proto file

目前IDE 支持的 Proto buffer 插件最流行有两个：

IDE 自带的，供应商是 JetBrains s.r.o. ✅✅✅ 三方 HIGAN ❌❌❌

目前这两个插件是冲突的，只能支持之一。⚠️

ApiHug Plugin 依赖 IDE 自带的 Proto Editor 插件，进行AST 语法树的解析，所以必须激活 JetBrains s.r.o. ✅ Proto插件:

Proto 文件不能import, cannot recognize the proto import

ApiHug SDK proto 导入 import "swagger/annotations.proto"; 报错：

ApiHug SDK proto import import "swagger/annotations.proto"; fail：

01: 编译项目, compile the project (markdown or gradle task)

02: 编译完成后，查看proto 项目的 build缓存， after compile success, check the project proto build cache:

{PROJECT}/{PROTO-MODULE}/build/extracted-include-protos:

03：如果还是没有引入，手动配置 proto import; if still not import then please add path manually：

open Settings panel find Protocol Buffers un-check Configure Automatically add the {PROJECT}/{PROTO-MODULE}/build/extracted-include-protos to the Import Paths:

最终所有 import 应该都变绿， Eventually all the import should turn green!

⚠️ sometime the official proto editor may crash, please pay attention to the crash notification!

if even restart IDEA this broken still consistent, please report to us: report issue

Gradle

不能识别Gradle, can not recognize as gradle project

IDE 应该弹出 Load Gradle Project, 如果通知被被关闭，打开 Notification 手动触发。

IDE should pop up a notification: Load Gradle Project， if notification pop up was forbidden, then please open the Notification panel to load it manually!

Gradle 编译报错, gradle compile failure

report issue Homepage find QR code to join out chat group.

API Design tree not present/refresh

refresh the tree rebuild the tree(heavy), recompile and then refresh

if the error still consistent, then report issue!

Check version

Check the ApiHug IDE plugin version installed:

Top Menu: ApiHug -> About:

Plugin 0.2+ issue

Please check here

Especially Spring boot upgrade！

Reference

ApiHug101-Bilibili ApiHug101-Youtube

总结

**ApiHug：API 设计神器，提升效率，减少错误，降低成本**
**概述**：
ApiHug是一款为开发者量身打造的API设计辅助插件，旨在通过优化工具链，提升API设计、开发和调试的效率。该插件与多个流行平台如Postman、Swagger及API设计工具无缝兼容，让开发者在创作过程中享受到“快、准、省”的三重体验。
**主要特点**：
- **快速集成**：ApiHug能快速集成到开发者的现有工作流程中，无论是使用Postman进行API测试，还是借助Swagger进行API设计，都能让开发者体验到流畅的操作和显著的效率提升。
- **精确分析**：通过智能化分析和提示功能，ApiHug帮助开发者在编写API文档和代码时减少错误，提高准确性和可靠性。它还支持对ProtoBuf等协议的深度解析，确保协议文件和API定义的高度一致性。
- **成本降低**：通过减少手动操作和重复性工作，ApiHug让开发者能更专注于核心功能的开发，从而降低项目成本和时间投入。
**常见问题与解决方案**：
1. **ProtoBuf支持问题**：
- **插件冲突：**IDE自带与三方ProtoBuf插件冲突，需选择其一。建议激活JetBrains官方插件以确保ApiHug正常运行。
- **导入问题：**遇到`import`无法识别时，可尝试编译项目，检查并手动配置proto文件的导入路径。
2. **Gradle相关问题：**
- **项目识别：**IDE未启动Gradle加载时，需手动触发或检查IDE设置。
- **编译错误：**遇到Gradle编译失败，先尝试基础排错，如仍有问题可联系ApiHug寻求帮助。
3. **API设计树更新：**
- 若API设计树未显示或未更新，首先尝试刷新或重建设计树。若问题持续存在，需提交问题报告给开发团队。
4. **版本检查：**
- 定期检查ApiHug插件版本，确保使用的是最新版本，以获得最佳兼容性和功能更新。
**资源与支持：**
- **文档与FAQ：**详细的文档和用户常见问题解答可在ApiHug官方网站和Gitee仓库中找到，为用户提供全面的技术支持和指导。
- **社区互动：**加入ApiHug社区，与其他开发者分享经验、交流心得，共同提升API设计能力。
- **反馈渠道：**发现问题或提出建议，可通过官方渠道联系开发团队，获得及时响应和解决。
**结语：**
ApiHug以用户为核心，不断优化产品体验和功能，致力于为开发者打造一个高效、准确、低成本的API设计环境。无论是初出茅庐的新手，还是身经百战的资深开发者，都能在ApiHug的帮助下，轻松应对API设计中的各种挑战。