# dropwz-example

**Repository Path**: zc2052/dropwz-example

## Basic Information

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

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-06
- **Last Updated**: 2026-05-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# dropwz-example

How to start the dropwz-example application
---

1. Run `mvn clean install` to build your application
1. Start application with `java -jar target/dropwz-example-1.0-SNAPSHOT.jar server example.yml`
1. To check that your application is running enter url `http://localhost:8978`

## 运行环境

- **HTTP 端口**: 8978
- **HTTPS 端口**: 8980
- **管理端口**: 8781

Health Check
---

To see your applications health enter url `http://localhost:8781/healthcheck`

## API 测试页面

项目提供了一个完整的 REST API 测试页面，方便测试所有用户相关的接口。

### 访问测试页面

启动应用后，在浏览器中访问：

- **HTTP**: http://localhost:8978/assets/user-api-test.html
- **HTTPS**: https://localhost:8980/assets/user-api-test.html

> **注意**: 使用 HTTPS 时，浏览器会显示安全警告（因为是自签名证书），需要点击"高级" -> "继续访问 localhost（不安全）"

### 测试的 API 接口

测试页面包含以下 8 个 API 接口的测试功能：

#### 1. 获取用户信息
- **方法**: GET
- **路径**: `/user/info/{fileName}`
- **功能**: 根据用户ID获取用户详细信息

#### 2. 更新用户头像
- **方法**: POST
- **路径**: `/user/avatar/{id}`
- **功能**: 更新指定用户的头像URL

#### 3. 单文件上传
- **方法**: POST
- **路径**: `/user/api/upload`
- **功能**: 上传单个文件（支持图片格式：jpg, jpeg, png, gif, webp）
- **限制**: 文件大小不超过 5MB

#### 4. 文件夹上传
- **方法**: POST
- **路径**: `/user/api/upload-folder`
- **功能**: 上传文件并保持目录结构
- **限制**: 文件大小不超过 10MB

#### 5. 文件下载
- **方法**: GET
- **路径**: `/user/api/download/{fileName}`
- **功能**: 下载指定文件，返回二进制数据

#### 6. Fork 仓库
- **方法**: POST
- **路径**: `/user/fork/{sourceRootDir}`
- **功能**: 将源用户的项目目录拷贝到目标用户目录
- **参数**:
  - `sourceRootDir`: 源项目根目录名称（如 dubbo）
  - `destUserName`: 目标用户名（如 lily）
  - `sourceUserName`: 源用户名（如 JackMordan）

#### 7. 获取文件信息
- **方法**: GET
- **路径**: `/user/api/file-info/{fileName}`
- **功能**: 获取文件的元数据信息（URL、文件名、大小等）

#### 8. 获取文件 Blob URL
- **方法**: GET
- **路径**: `/user/api/blob-url/{fileName}`
- **功能**: 获取带过期时间的文件访问URL
- **参数**:
  - `userId`: 用户ID（可选）
  - `expiresIn`: 过期时间（秒），默认 3600 秒

### 使用说明

1. **填写参数**: 在每个测试区域填写所需的参数
2. **点击按钮**: 点击对应的测试按钮执行 API 调用
3. **查看结果**: 响应结果会显示在下方的响应区域
   - 绿色文本表示成功
   - 红色文本表示失败

### 配置说明

如果需要修改 API 基础 URL，编辑 `src/main/resources/assets/user-api-test.html` 文件：

```javascript
const API_BASE_URL = 'https://localhost:8980/user'; // 修改这里的地址和端口
```

### 开发提示

如果需要修改测试页面：
1. 编辑源文件：`src/main/resources/assets/user-api-test.html`
2. 重新编译：`mvn clean package`
3. 重启应用
4. 刷新浏览器页面（Ctrl+F5 强制刷新）

## 其他资源

- **WebSocket 存储端点**: `wss://localhost:8980/api/storage/ws`
- **终端 WebSocket 端点**: `ws://localhost:8978/terminal`