ProtoBuf

Proto 文件无法识别

目前 IDE 支持的 Proto buffer 插件主要有两种:

  1. IDE 自带的,供应商为 JetBrains s.r.o. ✅✅✅
  2. 第三方 HIGAN 插件 ❌❌❌

这两个插件存在冲突,只能启用其中一个。⚠️

ApiHug Plugin 依赖于 IDE 自带的 Proto Editor 插件进行 AST 语法树解析,因此必须启用 JetBrains s.r.o. ✅ Proto 插件:

ApiHug plugin

Proto 文件无法导入,无法识别 proto import

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

ApiHug SDK proto import import "swagger/annotations.proto"; 失败:

ApiHug plugin SDK import error

01: 编译项目, compile the project (通过 markdown 或 gradle 任务)

ApiHug 2 ways build project

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

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

ApiHug success build

03:如果仍未成功导入,手动配置 proto import;if still not import then please add path manually:

  1. 打开 Settings 面板
  2. 找到 Protocol Buffers
  3. 取消勾选 Configure Automatically
  4. {PROJECT}/{PROTO-MODULE}/build/extracted-include-protos 添加到 Import Paths 中:

Plugin 0.7.6 版本起,插件已内置这些预定义的 proto 文件。

ApiHug import finally

最终所有 import 语句都应变为绿色,Eventually all the import should turn green!

⚠️ 有时官方的 proto editor 可能会崩溃,请留意崩溃提示!

若即使重启 IDEA 问题依旧存在,请向我们报告:report issue

Gradle

无法识别 Gradle 项目

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!

ApiHug Load gradle project

Gradle 编译失败

  1. report issue
  2. Homepage 查找二维码加入我们的交流群。

API 设计树未显示/未刷新

  1. 刷新树
  2. 重建树(耗时操作),重新编译后再刷新
ApiHug Rebuild

若错误仍然存在,则 report issue

检查版本

检查已安装的 ApiHug IDE 插件版本:

顶部菜单:ApiHug -> About

ApiHug version check

Plugin 0.2+ 问题

Milestone 20240222 特别是 Spring Boot 升级!

最新版本

参考资料

  1. ApiHug101-Bilibili
  2. ApiHug101-Youtube