Editor
Frequently asked questions about the ApiHug API Design Copilot
Currently, there are two popular Proto buffer
plugins supported by IDEs:
JetBrains s.r.o.
✅✅✅HIGAN
plugin ❌❌❌These two plugins conflict with each other and only one can be enabled at a time. ⚠️
The ApiHug Plugin relies on the IDE’s built-in Proto Editor plugin for AST parsing, so the JetBrains s.r.o.
✅ Proto plugin must be enabled:
ApiHug SDK proto import import "swagger/annotations.proto";
fails with an error:
ApiHug SDK proto import import "swagger/annotations.proto";
fails:
01: Compile the project (via markdown or gradle task)
02: After successful compilation, check the build cache of the proto project:
{PROJECT}/{PROTO-MODULE}/build/extracted-include-protos
:
03: If the import still fails, manually configure the proto import path; if imports are still not recognized, please add the path manually:
Settings
panelProtocol Buffers
Configure Automatically
{PROJECT}/{PROTO-MODULE}/build/extracted-include-protos
to the Import Paths
:Since Plugin version 0.7.6, these predefined protos are included by the plugin.
Eventually, all import
statements should turn green!
⚠️ Occasionally, the official proto editor may crash; please pay attention to any crash notifications.
If the issue persists even after restarting IDEA, please report it to us: report issue
The IDE should display a Load Gradle Project notification. If notifications are disabled, open the Notification panel to trigger it manually.
IDE should pop up a notification: Load Gradle Project; if the notification was disabled, please open the Notification panel to load it manually!
If the error persists, please report issue!
Check the installed version of the ApiHug IDE plugin:
Top Menu: ApiHug
-> About
:
Milestone 20240222 — Includes Spring Boot upgrade!