# api-master

**Repository Path**: kaelinda/api-master

## Basic Information

- **Project Name**: api-master
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-29
- **Last Updated**: 2026-02-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# API Master

<div align="center">

**本地化 API 测试与管理桌面应用**

[![Tauri](https://img.shields.io/badge/Tauri-2.0-blue?style=for-the-badge)](https://tauri.app/)
[![Vue 3](https://img.shields.io/badge/Vue-3.4-green?style=for-the-badge)](https://vuejs.org/)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.0-blue?style=for-the-badge)](https://www.typescriptlang.org/)
[![License](https://img.shields.io/badge/License-MIT-yellow?style=for-the-badge)](LICENSE)

*类似 Postman，但专注于本地数据存储和 Git 同步*

![API Master Screenshot](screenshot.png)

</div>

---

## 产品定位

API Master 是一款强调本地化体验的桌面 API 测试与管理工具。通过 Tauri + Vue 技术栈实现跨平台桌面应用，所有数据本地存储，仅 API 接口记录支持 Git 仓库同步。

### 核心价值

- **本地优先**: 所有数据本地存储，无需云端账号，保障数据隐私
- **Git 同步**: 通过 Git 仓库管理 API 集合，支持团队协作与版本控制
- **轻量高效**: 原生桌面应用，启动快速，资源占用低
- **开发友好**: 专为开发者设计的简洁界面和高效操作流程

---

## 功能特性

| 模块 | 功能 |
|------|------|
| **请求构建** | HTTP 方法、URL 智能提示、参数/Header/Body 配置、多种认证方式 |
| **响应分析** | 状态码、时间、Headers、JSON/XML/HTML 高亮、JSONPath 查询 |
| **集合管理** | 多层级文件夹、拖拽排序、批量操作、Git 版本控制 |
| **环境管理** | 多环境变量、Secret 隐藏显示、`{{variable}}` 语法 |
| **历史记录** | SQLite 本地存储、请求历史快速回溯 |
| **代码生成** | Fetch/Axios/cURL/Python/Go/Java 代码导出 |

---

## 快速开始

### 环境要求

- Node.js 18+
- pnpm 8+
- Rust 1.70+

### 安装依赖

```bash
pnpm install
```

### 开发模式

```bash
# 启动 Vue 开发服务器
pnpm dev

# 或启动 Tauri 桌面应用（开发模式）
pnpm tauri dev
```

### 构建发布

```bash
# 构建 Web 资源
pnpm build

# 构建桌面安装包
pnpm tauri build
```

### 代码质量

```bash
# ESLint 检查
pnpm lint

# TypeScript 类型检查
pnpm typecheck

# 运行测试
pnpm test          # UI 测试（Vitest）
cargo test         # Rust 测试
```

---

## 项目结构

```
api-master/
├── src/
│   ├── components/     # Vue 组件
│   │   ├── dialogs/    # 对话框
│   │   ├── request/    # 请求编辑相关
│   │   ├── response/   # 响应展示相关
│   │   ├── sidebar/    # 侧边栏
│   │   └── ...
│   ├── pages/          # 页面组件
│   ├── stores/         # Pinia 状态管理
│   ├── composables/    # Vue 组合式函数
│   ├── styles/         # 全局样式
│   └── main.ts         # 应用入口
├── src-tauri/          # Tauri Rust 后端
├── docs/               # 文档
└── tests/              # 测试用例
```

### 数据存储

```
用户数据目录/
├── config.json              # 应用配置
├── environments/            # 环境配置 (dev.json, staging.json, etc.)
├── collections/             # 集合数据
├── history.db               # 请求历史 (SQLite)
└── git-sync/                # Git 同步配置
```

---

## 技术栈

| 层级 | 技术 |
|------|------|
| 前端框架 | Vue 3 + TypeScript + Vite |
| UI 组件 | Element Plus / Ant Design Vue |
| 代码编辑器 | Monaco Editor / CodeMirror |
| 桌面框架 | Tauri (Rust 后端) |
| HTTP 客户端 | Tauri 原生 HTTP API |
| 状态管理 | Pinia |
| 本地存储 | LocalStorage / JSON 文件 + SQLite |

---

## Git 同步格式

集合同步到 Git 使用以下格式：

```
collections/{collection-name}/{request-name}.json
```

---

## 许可证

MIT License

---

## 致谢

- [Tauri](https://tauri.app/) - 构建跨平台桌面应用
- [Vue.js](https://vuejs.org/) - 渐进式 JavaScript 框架
- [Element Plus](https://element-plus.org/) - Vue 3 UI 组件库