# apiflow

**Repository Path**: wildsell/apiflow

## Basic Information

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

## Statistics

- **Stars**: 250
- **Forks**: 77
- **Created**: 2020-12-30
- **Last Updated**: 2026-04-21

## Categories & Tags

**Categories**: api-gateway

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

## README

<div align="center">

![logo](./docs/logo.jpg)

# Apiflow

## A Free, AI-Powered API Tool like Postman

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

[![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)

[Download](https://github.com/trueleaf/apiflow/releases)  | [Online Demo](https://apiflow.cn/)


<!-- [Download](https://github.com/trueleaf/apiflow/releases) ·
[Online Demo](https://apiflow.cn) -->
<!-- [Documentation](https://www.yuque.com/apiflow) · -->

</div>

---
# Preview

## AI Agent
![AI Agent](./docs/en/agent.gif)

## Server-Sent Events (SSE)
![SSE](./docs/en/sse.gif)

---
# What is Apiflow?

**Apiflow** is a **completely free**, **AI-powered API development platform** designed as a modern alternative to **Postman**, **Hoppscotch**, and **Insomnia**.

It supports **API testing**, **mocking**, **WebSocket**, **AI agents**, **team collaboration**, **offline usage**, and **local deployment** — while fully embracing the **OpenAPI 3.0 ecosystem**.

---

# Key Features

## 100% Free
- All features are free to use
- No paid plans, no feature limits

## AI Agent Built-In
- Built-in AI Agent for API design, testing and debugging
- Configure your own Large Language Model
- Works in offline or intranet environments

## Team Collaboration

- Built-in team and workspace management
- **Unlimited teams and members**
- Fine-grained permission control:
  - Project-level permissions
  - Role-based access control (RBAC)
  - Read / write / admin roles
- Operation history and change tracking
- Designed for teams of any size

## Offline & Online

- Local-first by design, online when you need it
- Full offline capability with local persistence
- Bidirectional conversion between offline and online data
- Smooth transition from personal usage to team collaboration
- Ideal for private networks and restricted environments


## Self-Hosted & Local Deployment
- One-click Docker deployment
- Data fully controlled by yourself
- Suitable for enterprises and private networks

## OpenAPI Friendly
- Import & export **OpenAPI 3.x**
- Seamlessly migrate data to:
  - Postman
  - Insomnia
  - Hoppscotch
  - Any OpenAPI-compatible tool

---

# Core Capabilities

- HTTP API testing (RESTful)
- WebSocket testing
- Mock Server (HTTP / WebSocket / SSE)
- Environment & variable system
- Pre-request & post-request scripts
- Project & folder management
- Import / Export (Postman, OpenAPI, JSON)
- Internationalization (EN / ZH / JA)

---



# Download

Download the latest version for your platform:

| Platform | Download |
|---------|----------|
| Windows | https://github.com/trueleaf/apiflow/releases |
| macOS | https://github.com/trueleaf/apiflow/releases |
| Linux | https://github.com/trueleaf/apiflow/releases |


---

# Local Deployment

## Server Deployment

### Docker Deployment

#### Requirements
- Docker
- Docker Compose

#### First Deployment

```bash
git clone https://github.com/trueleaf/apiflow
cd apiflow

cp .env.example .env
# edit .env to configure MongoDB credentials

docker compose pull
docker compose up -d

# Verify deployment
curl http://localhost
curl http://localhost/api/health
```

#### Adding Users After Deployment

After successfully deploying Apiflow, follow these steps to add users:

1. **Switch to Internet Mode**
   - Click the network mode toggle in the application (usually in the top-right corner)
   - Select "Internet Mode" to enable online features

2. **Login with Default Admin Account**
   - Username: `admin`
   - Default Password: `111111`
   - **Important**: Change the default password after first login for security

3. **Add New Users**
   - Navigate to the admin panel/backend management
   - Find the user management section
   - Click "Add User" to create new accounts for your team members

#### Code Update

If you are running Apiflow with Docker, updating the code does not require rebuilding locally.

**Option 1: Using Update Script (Recommended)**

```bash
# Make scripts executable (first time only)
chmod +x update.sh rollback.sh

# Run update
./update.sh
```

**Option 2: Manual Update**

```bash
docker compose down
docker compose pull
docker compose up -d
```

**Rollback (recommended: snapshot-based rollback)**

```bash
# Option 1: rollback to the latest snapshot created by update.sh (recommended)
./rollback.sh --previous

# Option 2: rollback to a specified snapshot file (recommended)
./rollback.sh --file current_versions_20260122_120000.txt

# Option 3: compatibility mode, rollback by tag/sha (not guaranteed to be exact, for emergencies)
./rollback.sh v1.2.3
# ./rollback.sh 7f3a2b1c4d5e
```

## Client Build

After deploying with Docker you can access the system directly via browser. If you want to use the full desktop experience, follow the steps below to build the client.

### Prerequisites
- **Node.js**: >= 22.0.0
- **macOS**: Xcode Command Line Tools required (`xcode-select --install`)
- **Linux**: `fakeroot` and `dpkg` for `.deb`; `rpm` for `.rpm` packages
- Each platform's installer can only be built on its native OS (no cross-platform compilation)

#### Step 1: Speed up downloads (optional)

Edit the `.npmrc` file in the project root and uncomment the following lines (remove the leading `#`):

```properties
ELECTRON_MIRROR=https://npmmirror.com/mirrors/electron/
ELECTRON_BUILDER_BINARIES_MIRROR=https://npmmirror.com/mirrors/electron-builder-binaries/
```

#### Step 2: Clone the repository and install dependencies

```bash
git clone https://github.com/trueleaf/apiflow.git
cd apiflow
npm install
```

#### Step 3: Modify configuration (as needed)

Edit `packages/web/src/config/config.ts` and adjust the following settings as required:

```typescript
// Change the backend server URL
// Default points to the official server; replace with your own when self-hosting
httpRequest: {
  url: isDev ? 'http://127.0.0.1:7001' : 'https://your-server.example.com',
  // ...
},
```

> **Note:** After packaging, the server URL can also be updated at any time in the app via **Settings → App Config → API Endpoint**, without needing to repackage.

#### Step 4: Run the build command for your platform

```bash
# Windows
npm run web:build:local:win

# macOS
npm run web:build:local:mac

# Linux
npm run web:build:local:linux

# Quick verification only (extract to directory, no installer, fastest)
npm run web:build:local:pack
```

> **Tip (Windows):** If the build command fails on Windows, try running the terminal as Administrator and execute the command again.

### Build Commands

| Command | Description |
|---------|-------------|
| `npm run web:build:local:pack` | Quick verification: extract to directory only, no installer, fastest option |
| `npm run web:build:local:win` | Build Windows installer (`.exe` NSIS) |
| `npm run web:build:local:mac` | Build macOS installer (`.dmg` + `.zip`, x64/arm64) |
| `npm run web:build:local:linux` | Build Linux packages (`.AppImage` + `.deb`, x64/arm64) |

### Output Directory

Build artifacts are located in `packages/web/release/`.

---

# Local Development

## Prerequisites
- **Node.js**: >= 22.0.0
- **MongoDB**: Running locally or accessible remotely
- **Git**: For cloning the repository

## Getting Started

1. **Clone the repository**

```bash
git clone https://github.com/trueleaf/apiflow.git
cd apiflow
npm install
```

2. **Start development servers**

```bash
npm run dev
```

This command will start both the frontend and backend servers concurrently:
- **Frontend (Web)**: http://localhost:4000
- **Backend (Server)**: http://localhost:7001

## Available Commands

| Command | Description |
|---------|-------------|
| `npm run dev` | Start both frontend and backend in development mode |
| `npm run dev:web` | Start only the frontend |
| `npm run web:dev` | Start only the frontend (alternative) |
| `npm run server:dev` | Start only the backend |
| `npm run web:build` | Build the web application |
| `npm run server:build` | Build the server application |
| `npm run server:test` | Run server unit tests |
| `npm run bootstrap` | Install all dependencies |

## Project Structure

This is a multi-package monorepo:

- `packages/web` - Frontend application (Vite + Vue 3 + Electron)
- `packages/server` - Backend application (Midway.js + MongoDB)
- `packages/website` - Marketing website (Next.js)

## Development Tips

- Ensure MongoDB is running before starting the server
- The frontend supports hot module replacement (HMR) for fast development
- Backend auto-restarts when files change
- You can develop packages independently by running their specific dev commands

---

# License

This project is licensed under the **MIT License**.  
See the [LICENSE](./LICENSE) file for details.