# api-put

**Repository Path**: asiainfo-cmit/api-put

## Basic Information

- **Project Name**: api-put
- **Description**: API测试工具
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-27
- **Last Updated**: 2025-11-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# API测试平台

基于Spring Boot + Vue3 + MySQL的API测试工具，参考Hoppscotch功能设计。

## 🚀 功能特性

- ✅ HTTP请求测试 (GET/POST/PUT/DELETE等)
- ✅ 请求参数和Headers配置
- ✅ 请求体编辑 (JSON/Form-Data/RAW)
- ✅ 响应显示和处理
- ✅ 集合管理
- ✅ 历史记录
- ✅ 环境变量
- ✅ 认证支持 (Bearer Token, Basic Auth, API Key)
- ✅ 响应测试脚本
- ✅ 实时请求执行
- ✅ 批量测试

## 🏗️ 技术栈

### 后端
- **Spring Boot 3.2.0** - 主框架
- **Spring Security** - 安全认证
- **Spring Data JPA** - 数据访问
- **MySQL 8.0** - 数据库
- **Redis** - 缓存
- **WebClient** - 响应式HTTP客户端
- **JWT** - 令牌认证

### 前端
- **Vue 3** - 前端框架
- **TypeScript** - 类型支持
- **Vite** - 构建工具
- **Element Plus** - UI组件库
- **Monaco Editor** - 代码编辑器
- **Pinia** - 状态管理
- **Axios** - HTTP客户端

### 部署
- **Docker** - 容器化
- **Docker Compose** - 编排
- **Nginx** - 反向代理

## 📋 环境要求

- Java 17+
- Node.js 18+
- MySQL 8.0+
- Redis 7+
- Docker & Docker Compose (可选)

## 🚀 快速开始

### 方式一：Docker部署（推荐）

1. **克隆项目**
```bash
git clone <repository-url>
cd api-test-platform
```

2. **启动服务**
```bash
# 启动所有服务
docker-compose up -d

# 查看服务状态
docker-compose ps
```

3. **访问应用**
- 前端：http://localhost
- 后端API：http://localhost:8080/api
- 数据库：localhost:3306
- Redis：localhost:6379

### 方式二：本地开发

#### 后端启动

1. **数据库准备**
```bash
# 创建数据库
mysql -u root -p
CREATE DATABASE api_test_platform;

# 导入数据库脚本
mysql -u root -p api_test_platform < database/init.sql
```

2. **配置文件**
```bash
cd backend
# 修改 src/main/resources/application.yml 中的数据库连接信息
```

3. **启动后端**
```bash
mvn clean install
mvn spring-boot:run
```

#### 前端启动

1. **安装依赖**
```bash
cd frontend
npm install
```

2. **启动开发服务器**
```bash
npm run dev
```

3. **访问应用**
- 开发环境：http://localhost:3000

## 📖 使用指南

### 1. 创建API请求

1. 选择HTTP方法（GET、POST、PUT、DELETE等）
2. 输入请求URL
3. 配置请求参数、Headers、Body等
4. 设置认证信息（如需要）
5. 点击"发送"执行请求

### 2. 请求配置

- **Params**：URL查询参数
- **Headers**：自定义请求头
- **Body**：请求体（支持JSON、Form-Data、Raw格式）
- **Auth**：认证配置（Bearer Token、Basic Auth、API Key）

### 3. 响应处理

- **Body**：查看响应内容，支持语法高亮
- **Headers**：查看响应头信息
- **Test**：编写测试脚本验证响应

### 4. 保存和管理

- 保存常用请求到集合
- 查看请求历史记录
- 管理环境变量

## 🔧 配置说明

### 后端配置

```yaml
# application.yml
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/api_test_platform
    username: your_username
    password: your_password
```

### 前端配置

```javascript
// vite.config.js
export default defineConfig({
  server: {
    proxy: {
      '/api': {
        target: 'http://localhost:8080',
        changeOrigin: true
      }
    }
  }
})
```

## 📝 API文档

### 认证接口
- `POST /api/auth/login` - 用户登录
- `POST /api/auth/register` - 用户注册

### API测试接口
- `POST /api/test/execute` - 执行API测试
- `POST /api/test/save` - 保存API请求
- `GET /api/test/requests/{id}` - 获取API请求
- `GET /api/test/history` - 获取请求历史

## 🛠️ 开发指南

### 添加新功能

1. **后端**
   - 创建Entity实体类
   - 创建Repository数据访问层
   - 创建Service业务逻辑层
   - 创建Controller控制器层

2. **前端**
   - 创建API接口定义
   - 创建Vue组件
   - 添加路由配置
   - 更新状态管理

### 代码规范

- 后端遵循阿里巴巴Java开发手册
- 前端使用ESLint + Prettier
- 提交信息遵循Conventional Commits

## 🧪 测试

```bash
# 后端测试
cd backend
mvn test

# 前端测试
cd frontend
npm run test
```

## 📦 部署

### Docker部署

```bash
# 构建镜像
docker-compose build

# 生产环境部署
docker-compose -f docker-compose.prod.yml up -d
```

### 传统部署

```bash
# 后端打包
cd backend
mvn clean package

# 前端打包
cd frontend
npm run build
```

## 🤝 贡献

欢迎提交Issue和Pull Request！

## 📄 许可证

MIT License

## 📞 联系方式

如有问题，请提交Issue或联系开发团队。