Api 设计，Plugin 支持Map 展示啦！

前文

刚好篇我们讨论了 ApiHug 里面如何使用不同类型的 max/min 定义， 里面说到 map , 自然我们在proto DSL 已经支持 map， 但是 IDEA 中还一直不支持 map 的展示， 所以在 0.7.6 我们加上啦！

Api 设计，你的max/min 长度、元素数与属性数用对了吗？-优快云博客文章浏览阅读765次，点赞24次，收藏20次。本文介绍了API设计中常用的验证关键字及其区别：针对数值类型使用minimum/maximum（可设置exclusive边界）；字符串使用minLength/maxLength限定长度；数组通过minItems/maxItems控制元素数量；对象则用minProperties/maxProperties限制属性数目。ApiHug严格遵循Swagger3.0规范，在Protobuf定义和Java代码生成中实现这些验证规则，并通过示例展示了数组和对象属性的具体实现方式。文章特别强调在API设计中应保持数据结构简https://blog.youkuaiyun.com/AK15221736052/article/details/149394989?spm=1011.2415.3001.5331Api 设计，为什么契约在内部和外部都如此重要-优快云博客文章浏览阅读587次，点赞15次，收藏10次。ApiHug通过契约机制有效弥合系统内外通信鸿沟。平台采用Swagger标准和DSL定义API契约，实现编译期静态检查，减少人为错误。其特色包括：严格遵循API设计原型测试工具Kola、基于protobuf构建的元语言支持，以及通过ContractAdapter提供的模块化定制能力（如MCP服务暴露控制）。最新版本1.4.1强化了企业级MCP功能，整合SpringAI安全机制，支持最小化改造现有系统。该方案通过标准化契约同时解决内部前后端协作和外部微服务集成问题。https://blog.youkuaiyun.com/AK15221736052/article/details/149407508?spm=1011.2415.3001.5331

0.7.6 Plugin Release Note:

[0.7.6] - 2025-08-15

​Features

• Upgrade default spring dependencies;
• Support protobuf map parser and show;
• Default protobuf linkage of the apihug extension;
• Bug fix;

Plugin Changelog - ApiHugChangelog of the ApiHug Plugin.https://apihug.github.io/zhCN-docs/changelog/plugin

IDEA FAQ

ApiHug API 设计助手 FAQ - ApiHugApiHug API 设计助手的常见问题https://apihug.github.io/zhCN-docs/idea/faq

ApiHug API 设计助手的常见问题

​ProtoBuf

​Proto 文件无法识别

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

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

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

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

​Proto 文件无法导入，无法识别 proto import

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

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

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

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. 打开 Settings 面板
2. 找到 Protocol Buffers
3. 取消勾选 Configure Automatically
4. 将 {PROJECT}/{PROTO-MODULE}/build/extracted-include-protos 添加到 Import Paths 中：

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

最终所有 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!

​Gradle 编译失败

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

​API 设计树未显示/未刷新

1. 刷新树
2. 重建树（耗时操作），重新编译后再刷新

若错误仍然存在，则 report issue！

​检查版本

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

顶部菜单：ApiHug -> About：

​Plugin 0.2+ 问题

Milestone 20240222 特别是 Spring Boot 升级！