# ApiForge

**Repository Path**: chenxin04187/api-forge

## Basic Information

- **Project Name**: ApiForge
- **Description**: ApiForge —— 企业级 API 设计协作平台。用真正的 Git 工作流锻造 OpenAPI 规范，支持分支版本目录、基线化发布与 MCP 协议。让 API 的设计、评审与发布像管理代码一样严谨高效
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-14
- **Last Updated**: 2026-06-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ApiForge - 企业级 API 设计与协作平台

[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
[![Java](https://img.shields.io/badge/Java-17%2B-orange)](https://openjdk.org)
[![Spring Boot](https://img.shields.io/badge/Spring%20Boot-3.x-brightgreen)](https://spring.io/projects/spring-boot)

> **锻造你的 API，用 Git 的方式。**

ApiForge 是一款内部部署的 API 设计协作平台，对标 SwaggerHub On-Premise，专为追求工程化的团队打造。  
它以 OpenAPI 3.0 为核心，将 **真正的 Git 版本控制**、**分支式版本目录**、**基线化发布** 和 **MCP 协议原生集成** 融为一体，让 API 的设计、评审、发布，以及与 AI 智能体的协作，都在同一个平台上流畅完成。

---

## ✨ 为什么选择 ApiForge？

- 🔀 **真正的 Git 工作流**  
  分支、合并、标签、历史追溯——像管理代码一样管理 API 规范，零学习成本。

- 📅 **版本目录与基线化**  
  为每个业务版本（如 3.54.0）创建分支，完成开发后**锁定并打标签**，上线后再合并回主干。每个 API 的新增、优化都有清晰记录。

- 🤖 **MCP 原生支持**  
  内置 MCP Server，AI Agent 可以通过标准协议推送、读取、对比 OpenAPI 文档，参与设计评审、自动生成 Release Note 等。

- 📝 **双视图编辑器**  
  Monaco 代码编辑器 + 实时预览，双向联动，所见即所得。

- 🔍 **API 粒度历史**  
  不仅能看整个文档的变更，还可以追踪每一个路径、每一个 Schema 的完整演进历史。

- 👥 **团队协作与权限**  
  成员角色、分支保护、合并请求（PR）、行内评论，满足企业内部协作需求。

- 📤 **灵活导出**  
  一键生成 HTML 静态站、OpenAPI 3.0 (YAML/JSON)、Markdown 文档，方便离线交付。

- ☁️ **单机 / 集群灵活部署**  
  单机版开箱即用，也支持集群部署 + 共享存储，适应不同规模。

---

## 🧱 系统架构

ApiForge 采用 **关系数据库 + 真实 Git 裸仓库** 的混合存储模型：

- **数据库**：存储用户、权限、解析后的 API 实体、变更日志、PR 等协作数据。
- **Git 裸仓库**：每个项目背后一个完整的 Git 仓库，保存所有文档快照，原生支持分支、标签、合并。
- **共享存储（集群）**：通过 NFS 或对象存储挂载，多实例共享 Git 仓库目录。


---

## 🎯 核心功能

| 模块 | 功能 |
|------|------|
| **API 设计** | OpenAPI 3.0 导入/创建、在线编辑、实时预览、多文件结构 |
| **版本控制** | 分支创建、提交历史、差异对比、合并、冲突处理 |
| **发布管理** | 分支 → 基线化（打 Tag 并锁定）→ 上线后合并回主干，形成版本目录 |
| **协作** | 多用户管理、角色权限、分支保护、PR 评审、行内评论 |
| **MCP** | 内置 MCP Server，暴露 Tools 和 Resources，供 AI Agent 调用 |
| **导出** | HTML 文档站、OpenAPI (YAML/JSON)、Markdown、SDK（规划中） |
| **治理** | 规范校验（Spectral）、破坏性变更检测、Mock 服务（规划中） |
| **部署** | 内嵌 H2 快速体验，支持 PostgreSQL/MySQL，集群扩展 |

---

## 🛠️ 技术栈

- **后端**：Spring Boot 3.x · Spring Security · Spring Data JPA · JGit
- **前端**：React · Monaco Editor · Swagger UI / Redoc 组件
- **数据库**：PostgreSQL（生产推荐）· H2（单机内嵌）
- **协议**：MCP（JSON-RPC 2.0）· RESTful API
- **工具链**：Spectral · openapi-generator

---

## 🚀 快速启动（开发阶段）

```bash
# 克隆项目
git clone https://gitee.com/chenxin04187/api-forge.git
cd apiforge

# 后端（需 Java 17+）
./mvnw spring-boot:run

# 前端
cd frontend
npm install
npm run dev
```
---
打开 http://localhost:8080 进入工作台。

---
## 🗺️ 路线图
需求分析与架构设计

MVP：核心编辑、Git 分支历史、基线化、基本权限

MCP Server 稳定版，AI Agent 接入

PR 评审、行内评论、破坏性变更检测

Mock 服务与 SDK 生成

发布门户与自定义域名

集群高可用部署方案

## 🤝 贡献
项目处于早期建设阶段，欢迎 Issue 讨论和 PR 贡献。
让我们一起打造更专业的 API 设计协作方式。

## 📄 许可证
Apache 2.0 License