# apiflow

**Repository Path**: wildsell/apiflow

## Basic Information

- **Project Name**: apiflow
- **Description**: 企业级开源接口文档管理工具
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://online.jobtool.cn
- **GVP Project**: No

## Statistics

- **Stars**: 239
- **Forks**: 77
- **Created**: 2020-12-30
- **Last Updated**: 2026-01-04

## Categories & Tags

**Categories**: api-gateway

**Tags**: MongoDB, 接口工具, midwayjs, API工具

## README

<div align="center">

![logo](https://images.gitee.com/uploads/images/2021/0331/214909_4f34bc9b_1230427.png)

# Apiflow

### Postman / Apifox 开源替代方案

[English](./README.md) | 中文

[![GitHub Release](https://img.shields.io/github/v/release/trueleaf/apiflow?style=flat-square)](https://github.com/trueleaf/apiflow/releases/latest)
[![License](https://img.shields.io/github/license/trueleaf/apiflow)](https://github.com/trueleaf/apiflow/blob/master/LICENSE)
[![Downloads](https://img.shields.io/github/downloads/trueleaf/apiflow/total)](https://github.com/trueleaf/apiflow/releases/latest)

[下载](https://github.com/trueleaf/apiflow/releases) | [在线演Demo](https://apiflow.cn/)


</div>

---

## 🖥️ 界面预览

（此处可添加产品截图）

---

## 🚀 Apiflow 是什么？

**Apiflow** 是一个 **完全免费**、**内置 AI 能力** 的 API 接口工具，致力于成为  
**Postman、Apifox 的现代化开源替代方案**。

它集成了 **API 测试、Mock、WebSocket、AI Agent、团队协作、离线使用、本地部署** 等能力，并全面拥抱 **OpenAPI 3.0 生态体系**。

---

## ✨ 核心特性

### ✅ 完全免费
- 所有功能永久免费
- 无付费计划
- 无功能限制
- 一键导出到postman、apifox等工具

### 🤖 内置 AI Agent
- 内置 AI Agent，辅助 API 设计、测试与调试
- 支持配置你自己的大语言模型（LLM）
- 支持 **离线 / 内网环境** 使用

### 👥 团队协作
- 内置团队与工作区管理
- **团队数量、成员数量不限**
- 细粒度权限控制：
  - 项目级权限
  - 基于角色的权限管理（RBAC）
  - 只读 / 编辑 / 管理员角色
- 操作记录与变更历史追踪
- 适用于任何规模的团队

### 📴 离线 & 在线
- Local-First 设计理念
- 完整离线能力，本地数据持久化
- 离线 / 在线数据双向转换
- 从个人使用平滑过渡到团队协作
- 非常适合内网或受限网络环境

### 🏠 自托管 & 本地部署
- Docker 一键部署
- 数据完全由自己掌控
- 适用于企业私有化部署场景

### 🔄 OpenAPI 友好
- 支持 **OpenAPI 3.x** 导入 / 导出
- 可无缝迁移到：
  - Postman
  - Insomnia
  - Hoppscotch
  - 任意 OpenAPI 兼容工具

---

## 🧩 核心能力一览

- HTTP API 测试（RESTful）
- WebSocket 测试
- Mock Server（HTTP / WebSocket / SSE）
- 环境变量与变量系统
- 请求前 / 请求后脚本
- 项目与文件夹管理
- 导入 / 导出（Postman / OpenAPI / JSON）
- 国际化支持（英文 / 中文 / 日文）

---

## ⬇️ 下载

获取适用于你平台的最新版本：

| 平台 | 下载地址 |
|------|----------|
| 🪟 Windows | https://github.com/trueleaf/apiflow/releases |
| 🍎 macOS | https://github.com/trueleaf/apiflow/releases |
| 🐧 Linux | https://github.com/trueleaf/apiflow/releases |

---

## 💻本地开发

### 环境要求
- **Node.js**: >= 20.0.0
- **MongoDB**: 本地运行或远程可访问
- **Git**: 用于克隆代码仓库

### 快速开始

1. **克隆代码仓库**

```bash
git clone https://gitee.com/wildsell/apiflow.git
cd apiflow
```

2. **安装依赖**

```bash
npm install
# 或者
npm run bootstrap
```

此命令会分别安装 `packages/web` 和 `packages/server` 的依赖。

3. **配置环境变量**

根据需要在 `packages/server/src/config/` 目录下创建或编辑配置文件。

4. **启动开发服务器**

```bash
npm run dev
```

此命令会同时启动前端和后端开发服务器：
- **前端 (Web)**: http://localhost:4000
- **后端 (Server)**: http://localhost:7001

### 可用命令

| 命令 | 说明 |
|------|------|
| `npm run dev` | 同时启动前端和后端开发服务器 |
| `npm run dev:web` | 仅启动前端开发服务器 |
| `npm run web:dev` | 仅启动前端开发服务器（备用） |
| `npm run server:dev` | 仅启动后端开发服务器 |
| `npm run web:build` | 构建 Web 应用 |
| `npm run server:build` | 构建 Server 应用 |
| `npm run server:test` | 运行后端单元测试 |
| `npm run bootstrap` | 安装所有依赖 |

### 项目结构

这是一个多包项目（monorepo）：

- `packages/web` - 前端应用（Vite + Vue 3 + Electron）
- `packages/server` - 后端应用（Midway.js + MongoDB）
- `packages/website` - 官网（Next.js）

### 开发提示

- 启动 Server 前请确保 MongoDB 已运行
- 前端支持热模块替换（HMR），可快速开发调试
- 后端文件变更时会自动重启
- 可以通过运行特定命令独立开发各个包

---

## 🐳 本地部署（Docker）

### 环境要求
- Docker
- Docker Compose

### 首次部署

```bash
git clone https://gitee.com/wildsell/apiflow
cd apiflow

cp .env.example .env
# 编辑 .env，配置 MongoDB 等参数

docker compose -f docker-compose.yml -f docker-compose.cn.yml pull
docker compose -f docker-compose.yml -f docker-compose.cn.yml up -d

# 验证部署
curl http://localhost             
curl http://localhost/api/health 
```

## 🚀 代码更新

如果你是通过 Docker 运行 Apiflow，更新代码时无需在本地重新构建。

只需拉取最新镜像并重启服务即可：
```bash
docker compose -f docker-compose.yml -f docker-compose.cn.yml pull
docker compose -f docker-compose.yml -f docker-compose.cn.yml up -d
```
## 📜 许可证

本项目采用 **MIT** 许可证进行许可

详情请参阅 [LICENSE](./LICENSE)