IDE Plugin FAQ-ApiHug - API design Copilot

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

  1. GitHub - apihug/apihug.com: All abou the Apihug
  2. apihug.com: 有爱,有温度,有质量,有信任
  3. 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 插件最流行有两个:

  1. IDE 自带的, 供应商是 JetBrains s.r.o. ✅✅✅
  2. 三方 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:

  1. open Settings panel
  2. find Protocol Buffers
  3. un-check Configure Automatically
  4. 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

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

API Design tree not present/refresh

  1. refresh the tree
  2. 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

  1. ApiHug101-Bilibili
  2. ApiHug101-Youtube
相关推荐
麦麦鸡腿堡几秒前
Java的单例设计模式-饿汉式
java·开发语言·设计模式
假客套3 分钟前
Request method ‘POST‘ not supported,问题分析和解决
java
傻童:CPU4 分钟前
C语言需要掌握的基础知识点之前缀和
java·c语言·算法
爱吃山竹的大肚肚14 分钟前
@Valid校验 -(Spring 默认不支持直接校验 List<@Valid Entity>,需用包装类或手动校验。)
java·开发语言
may_一一40 分钟前
pycharm\python 安装下载
ide·python·pycharm
雨夜之寂43 分钟前
mcp java实战 第一章-第一节-MCP协议简介.md
java·后端
摇滚侠1 小时前
Spring Boot 3零基础教程,WEB 开发 Thymeleaf 核心语法 笔记39
spring boot·笔记·后端·thymeleaf
皮皮林5511 小时前
蚂蚁又开源了一个顶级 Java 项目!
java
吹晚风吧1 小时前
spring是如何解决循环依赖的(二级缓存不行吗)?
java·spring·循环依赖·三级缓存
九丶弟2 小时前
SpringBoot的cache使用说明
java·spring boot·spring·cache