ApiHug Api design copilot FAQ

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!