# apiweave-desktop

**Repository Path**: bingdor/apiweave-desktop

## Basic Information

- **Project Name**: apiweave-desktop
- **Description**: Elegant API testing tool for developers. MCP-powered, seamlessly works with AI coding tools. Data synced to your   private Git repository for security and collaboration.
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-31
- **Last Updated**: 2026-03-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
  <img src="resources/app-logo.png" width="128" alt="ApiWeave">
</p>

<h1 align="center">ApiWeave</h1>

<p align="center">
  <strong>Elegant API testing tool for developers.</strong><br>
  MCP-powered, seamlessly works with AI coding tools. Data synced to your private Git repository for security and collaboration.
</p>

<p align="center">
  <a href="https://github.com/bingdor/apiweave-desktop/releases"><img src="https://img.shields.io/badge/version-1.0.2-blue" alt="Version"></a>
  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-green" alt="License"></a>
  <img src="https://img.shields.io/badge/platform-macOS%20%7C%20Windows%20%7C%20Linux-lightgrey" alt="Platform">
  <img src="https://img.shields.io/badge/electron-28-blue" alt="Electron">
</p>

---

## Screenshots

<p align="center">
  <img src="resources/screenshots/1.png" width="800" alt="Welcome Screen"><br>
  <em>Collections & Welcome Screen</em>
</p>

<p align="center">
  <img src="resources/screenshots/2.png" width="800" alt="Request Editor"><br>
  <em>Request Editor with JSON Body</em>
</p>

<p align="center">
  <img src="resources/screenshots/3.png" width="800" alt="Response Panel"><br>
  <em>Request & Response Split View</em>
</p>

<p align="center">
  <img src="resources/screenshots/4.png" width="800" alt="Test Cases"><br>
  <em>Test Cases with Run Results</em>
</p>

<p align="center">
  <img src="resources/screenshots/5.png" width="800" alt="Scripts & Testing"><br>
  <em>Post-Response Scripts & Assertions</em>
</p>

<p align="center">
  <img src="resources/screenshots/6.png" width="800" alt="Environments"><br>
  <em>Environment Variables Management</em>
</p>

<p align="center">
  <img src="resources/screenshots/7.png" width="800" alt="Git Sync"><br>
  <em>Git Repository Sync</em>
</p>

<p align="center">
  <img src="resources/screenshots/8.png" width="800" alt="API Schema"><br>
  <em>OpenAPI Schema Documentation</em>
</p>

## Highlights

- **Full HTTP Support** — GET / POST / PUT / DELETE / PATCH / HEAD / OPTIONS with query params, headers, and multiple body types (JSON, form-data, x-www-form-urlencoded, raw)
- **Collections & Folders** — Organize requests into collections with multi-level folder nesting
- **Environment Variables** — Switch between multiple environments; use `{{variable}}` placeholders anywhere
- **Scripting & Testing** — Pre-request and post-response scripts with built-in `aw.*` API, Chai-style assertions, CryptoJS, and lodash
- **Test Cases** — Define per-request test cases with variable overrides, custom params/headers/body, and independent scripts
- **Dynamic Variables** — Built-in `{{$guid}}`, `{{$timestamp}}`, `{{$randomInt}}`, and more
- **Collection Runner** — Run all requests in a collection sequentially with CSV/JSON iteration data
- **MCP Integration** — Built-in MCP server for AI-assisted API testing via Claude Code, Cursor, etc.
- **Git Sync** — Push/pull collections to any Git repository (GitHub, GitLab, Gitee, self-hosted)
- **Import & Export** — JSON export/import and Postman collection import
- **100% Local** — All data stored on disk, zero telemetry

## Download

Download the latest release from [GitHub Releases](https://github.com/bingdor/apiweave-desktop/releases).

| Platform | File |
|----------|------|
| macOS (Apple Silicon) | `ApiWeave-x.x.x-arm64.dmg` |
| macOS (Intel) | `ApiWeave-x.x.x-x64.dmg` |
| Windows (installer) | `ApiWeave Setup x.x.x.exe` |
| Windows (portable) | `ApiWeave x.x.x.exe` |

## Quick Start

```bash
# Clone
git clone https://github.com/bingdor/apiweave-desktop.git
cd apiweave-desktop

# Install dependencies
npm install

# Run in development mode
npm run dev
```

## Build

```bash
# Current platform
npm run dist

# Specific platform
npm run dist:win    # Windows
npm run dist:mac    # macOS
npm run dist:linux  # Linux
```

Build output is in the `release/` directory.

## MCP Integration

ApiWeave ships with a built-in [MCP](https://modelcontextprotocol.io/) server, allowing AI coding assistants to manage and execute your API requests.

### Auto-Registration

**No manual configuration needed.** When you launch ApiWeave for the first time, it automatically:

1. Installs the MCP server to your local data directory
2. Creates an `apiweave-mcp` command in your system PATH
3. Detects installed AI coding tools and registers the MCP server

Supported tools with auto-registration:

| AI Coding Tool | Config File | Status |
|---------------|-------------|--------|
| [Claude Code](https://claude.ai/code) | `~/.claude.json` | Auto-registered |
| [Cursor](https://cursor.com) | `~/.cursor/mcp.json` | Auto-registered |
| [Trae](https://trae.ai) | Platform-specific `mcp.json` | Auto-registered |
| [Qoder](https://qoder.ai) | Platform-specific `mcp.json` | Auto-registered |
| [Open Code](https://opencode.ai) | `~/.opencode.json` | Auto-registered |

Just restart your AI coding tool after launching ApiWeave — the MCP server will be ready to use.

### Manual Setup

If auto-registration doesn't work for your tool, you can configure it manually:

```json
{
  "mcpServers": {
    "apiweave": {
      "command": "apiweave-mcp"
    }
  }
}
```

Or use the full path if the CLI command is not in your PATH:

```json
{
  "mcpServers": {
    "apiweave": {
      "command": "node",
      "args": ["~/Library/Application Support/ApiWeave/mcp/server.js"]
    }
  }
}
```

### Available MCP Tools

`list_collections`, `create_collection`, `create_request`, `execute_request`, `execute_case`, `execute_cases`, `list_environments`, `set_active_environment`, and more. Use `get_scripting_api_doc` to get the full scripting API reference.

## Data Storage

All data is stored locally:

| Platform | Path |
|----------|------|
| macOS | `~/Library/Application Support/ApiWeave/` |
| Windows | `%APPDATA%\ApiWeave\` |
| Linux | `~/.config/ApiWeave/` |

## Tech Stack

| Layer | Technology |
|-------|-----------|
| Framework | Electron 28 |
| Build | electron-vite + Vite 5 |
| Frontend | React 18 + TypeScript |
| State | Zustand |
| Styling | Tailwind CSS |
| HTTP | axios |
| Git | simple-git |
| MCP | @modelcontextprotocol/sdk |
| Packaging | electron-builder |

## Contributing

Contributions are welcome!

1. Fork the repository
2. Create a feature branch: `git checkout -b feature/my-feature`
3. Commit your changes: `git commit -m 'feat: add my feature'`
4. Push and open a Pull Request

## License

[MIT](LICENSE)

---

<p align="center">Made with care by the ApiWeave community</p>