FILE_UPLOAD_README.md 1.4 KB

文件上传功能说明

功能特性

  • 支持文件上传到指定目录
  • 使用环境变量配置存储路径
  • 自动生成唯一文件名避免冲突
  • 返回详细的文件信息

环境变量配置

在项目根目录创建 .env 文件,添加以下配置:

# 文件上传配置
FILE_PATH=./uploads

# 其他配置...
DB_HOST=localhost
DB_PORT=3306
DB_USERNAME=root
DB_PASSWORD=123456
DB_DATABASE=books
PORT=3000

API 使用

上传文件

POST /file/upload

使用 multipart/form-data 格式上传文件,字段名为 file

请求示例:

curl -X POST http://localhost:3000/file/upload \
  -F "file=@/path/to/your/file.jpg"

响应示例:

{
  "success": true,
  "message": "文件上传成功",
  "data": {
    "originalName": "example.jpg",
    "fileName": "1703123456789_example.jpg",
    "filePath": "/path/to/uploads/1703123456789_example.jpg",
    "fileUrl": "/uploads/1703123456789_example.jpg",
    "size": 1024,
    "mimeType": "image/jpeg",
    "uploadTime": "2023-12-21T10:30:45.123Z"
  }
}

安装依赖

确保安装了必要的依赖:

pnpm add @nestjs/config multer @types/multer

注意事项

  1. 确保 FILE_PATH 环境变量已正确设置
  2. 上传目录会自动创建(如果不存在)
  3. 文件名会自动添加时间戳前缀以避免冲突
  4. 建议在生产环境中配置静态文件服务来访问上传的文件