什么是 ApiHug？

ApiHug 把 protobuf 契约放到系统中心位置，再围绕这份契约组织设计、生成、实现、评审和分发流程。

它是什么

ApiHug 把四类能力收拢到同一个产品面里：

• 基于 protobuf 的 contract-first API 设计
• 面向后端、元数据和客户端产物的生成能力
• 保证手写代码不越界的规则体系
• 理解同一份契约与规则的 AI 工作流

换句话说，一份契约不只定义接口，也定义了后续生成、实现、集成和 AI 辅助交付的边界。

为什么重要

API 团队最容易出问题的地方，往往不是单点设计，而是设计、实现和评审之间逐步漂移。ApiHug 通过让契约成为 source of truth，把这类漂移压到最低。

这会直接带来几件事：

• 设计和实现更容易保持同步
• 可以安全地重复生成，而不是反复手改
• 评审依据更明确，不再停留在泛泛的代码风格层面
• 对 AI、SDK 使用方和内部协作方暴露出更清晰的系统表面

它如何融入整体流程

ApiHug 贯穿从设计到集成的完整交付链路：

设计

用 protobuf 定义 service、operation、message、enum 和持久化元数据。

构建

基于契约生成后端脚手架、OAS 输出和其他框架产物。

实现

业务逻辑只写在允许手写的层里。

评审

用 ApiHug 的规则和工作流技能校验契约与实现是否仍然一致。

分发

通过 Maven 等既有仓库基础设施发布带版本的产物。

常见问题

ApiHug 可以免费使用吗？

可以。无论是商业项目还是内部平台项目，都可以使用 ApiHug。

ApiHug 是开源的吗？

SDK 会发布到公共 Maven 仓库。IntelliJ 插件源码当前没有公开。

为什么叫 ApiHug？

We Build What We Love & Love What We Built

API 是契约本身，Hug 表示把工程师、消费者和 AI 工具放进同一个共享系统模型里。

下一步

1. 从 快速开始 进入实际项目
2. 阅读 技能与规则
3. 继续了解 工具链