# api-gateway

**Repository Path**: captain-duan/api-gateway

## Basic Information

- **Project Name**: api-gateway
- **Description**: 通用的api网关应用
- **Primary Language**: Java
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-25
- **Last Updated**: 2026-07-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 统一 API 网关

## 项目说明

本项目是数据中台统一 API 网关，用于集中管理接口资产、版本发布、灰度策略、权限审批、配置发布、监控审计和调用方门户。

Workflow v2 是本仓库唯一允许的运行方式。AI 会话必须先读取 `workflow/CURRENT_PHASE.md`、`workflow/WORKFLOW_STATUS.md`、`workflow/WORKFLOW_MANIFEST.md`、`workflow/WORKFLOW_RULES.md` 和当前 Phase Context 文件，再继续执行。

## 当前组成

| 模块 | 路径 | 说明 |
| --- | --- | --- |
| 前端控制台 | `frontend/frontend` | React、TypeScript、Vite、Ant Design。 |
| 后端服务 | `backend` | Java 21、Spring Boot、JDBC 持久化、MySQL/Flyway、Redis 运行态、管理 API 和 Gateway 治理链路。 |
| API 契约 | `docs/openapi.yaml` | 当前后端与前端对齐的接口契约。 |
| 数据库脚本 | `backend/src/main/resources/db/migration` | MySQL 表结构迁移脚本。 |
| Workflow v2 | `workflow/` | 当前 Phase、状态、规则、决策队列和评审记录。 |

## 本地运行

### 后端

```bash
cd backend
mvn spring-boot:run -Dspring-boot.run.jvmArguments=-Dserver.port=8080
```

默认后端配置读取 MySQL 和 Redis：

- `API_GATEWAY_DB_URL`
- `API_GATEWAY_DB_USERNAME`
- `API_GATEWAY_DB_PASSWORD`
- `API_GATEWAY_REDIS_HOST`
- `API_GATEWAY_REDIS_PORT`
- `API_GATEWAY_REDIS_PASSWORD`
- `API_GATEWAY_REDIS_DATABASE`
- `API_GATEWAY_REDIS_KEY_PREFIX`

本地无 MySQL/Redis 时，可使用测试夹具执行联调：

```bash
cd backend
mvn spring-boot:test-run -Dspring-boot.run.profiles=test -Dspring-boot.run.arguments=--server.port=18080
```

健康检查：

```bash
curl http://127.0.0.1:8080/actuator/health
```

### 前端

```bash
cd frontend/frontend
npm install
npm run dev -- --host 127.0.0.1 --port 5174
```

前端 dev server 已配置代理，默认指向 `http://127.0.0.1:8080`，也可通过 `VITE_BACKEND_TARGET` 指定：

- `/admin` -> `http://127.0.0.1:8080`
- `/developer` -> `http://127.0.0.1:8080`
- `/gateway` -> `http://127.0.0.1:8080`

## 验证命令

```bash
cd frontend/frontend
npm run lint
npm run build
```

```bash
cd backend
mvn test
```

## 上线文档

- 部署文档：`docs/deployment.md`
- 回滚文档：`docs/rollback.md`
- 测试报告：`docs/test-report.md`
- 联调报告：`docs/integration-report.md`

## 当前状态

- 后端主路径已接入 JDBC 持久化、Flyway 迁移、Redis 运行态接口、操作审计和 Gateway 治理链路。
- 报表导出首期使用数据库外部引用字段，指向本地文件路径；未来对象存储迁移不属于首期范围。
- 前端生产包体积存在 Vite 默认阈值提示，当前不阻塞上线准备，后续可做路由级懒加载优化。