对号 jo!
  1. 三、应用模块接口
对号 jo!
  • 一、项目说明
  • 二、接口说明
  • 三、应用模块接口
    • 3.1 系统相关API
    • 3.2 网盘文件API
    • 3.3 媒体相关API
    • 3.4 资源相关API
    • 3.5 用户相关API
    • 3.6 分享管理API
  • 四、开发说明
    • 4.1 技术开发总述
    • 4.2 通用数据库接口说明
    • 4.3 前端 API 调用示例
    • 4.3 后端API实现
  1. 三、应用模块接口

3.2 网盘文件API

3.2.1 获取文件列表#

URL:/files/list/{parentId}
方法:GET
参数:
parentId:父文件夹 ID,默认为 folder_root
返回数据:
{
  "code": 200,
  "message": "成功",
  "data": {
    "files": [
      {
        "id": "file_123",
        "name": "文档",
        "type": "folder",
        "size": 0,
        "created_at": "2024-01-01 00:00:00",
        "updated_at": "2024-01-01 00:00:00",
        "is_favorite": false,
        "is_shared": false
      },
      {
        "id": "file_456",
        "name": "图片.jpg",
        "type": "file",
        "size": 1024000,
        "created_at": "2024-01-01 00:00:00",
        "updated_at": "2024-01-01 00:00:00",
        "is_favorite": true,
        "is_shared": false
      }
    ]
  }
}

3.2.2 搜索文件#

URL:/files/search
方法:GET
参数:
keyword:搜索关键词
file_type:文件类型,可选
is_favorite:是否收藏,可选
返回数据:
{
  "code": 200,
  "message": "成功",
  "data": {
    "files": [
      {
        "id": "file_456",
        "name": "图片.jpg",
        "type": "file",
        "size": 1024000,
        "created_at": "2024-01-01 00:00:00",
        "updated_at": "2024-01-01 00:00:00",
        "is_favorite": true,
        "is_shared": false
      }
    ]
  }
}

3.2.3 创建文件夹#

URL:/files/create-folder
方法:POST
参数:
{
  "parent_id": "folder_root",  // 父文件夹 ID
  "name": "新文件夹"           // 文件夹名称
}
返回数据:
{
  "code": 200,
  "message": "成功",
  "data": {
    "id": "folder_789",
    "name": "新文件夹",
    "type": "folder",
    "size": 0,
    "created_at": "2024-01-01 00:00:00",
    "updated_at": "2024-01-01 00:00:00"
  }
}

3.2.4 上传文件#

URL:/files/upload
方法:POST
参数:
file:文件对象(FormData 格式)
parent_id:父文件夹 ID(可选,默认为 folder_root)
返回数据:
{
  "code": 200,
  "message": "成功",
  "data": {
    "id": "file_101",
    "name": "上传的文件.jpg",
    "type": "file",
    "size": 2048000,
    "created_at": "2024-01-01 00:00:00",
    "updated_at": "2024-01-01 00:00:00"
  }
}

3.2.5 删除文件/文件夹#

URL:/files/delete/{fileId}
方法:DELETE
参数:
fileId:文件或文件夹 ID
返回数据:
{
  "code": 200,
  "message": "成功",
  "data": {
    "success": true
  }
}

3.2.6 更新文件#

URL:/files/update/{fileId}
方法:PUT
参数:
{
  "name": "新文件名",        // 新文件名(可选)
  "is_favorite": true,       // 是否收藏(可选)
  "parent_id": "folder_789"  // 新的父文件夹 ID(可选)
}
返回数据:
{
  "code": 200,
  "message": "成功",
  "data": {
    "id": "file_456",
    "name": "新文件名.jpg",
    "type": "file",
    "size": 1024000,
    "created_at": "2024-01-01 00:00:00",
    "updated_at": "2024-01-01 00:00:00",
    "is_favorite": true,
    "parent_id": "folder_789"
  }
}

3.2.7 下载文件#

URL:/files/download/{fileId}
方法:GET
参数:
fileId:文件 ID
返回数据:文件二进制数据(Blob 格式)

3.2.8 列出回收站#

URL:/files/recycle
方法:GET
参数:无
返回数据:
{
  "code": 200,
  "message": "成功",
  "data": {
    "files": [
      {
        "id": "file_456",
        "name": "删除的文件.jpg",
        "type": "file",
        "size": 1024000,
        "deleted_at": "2024-01-01 00:00:00"
      }
    ]
  }
}

3.2.9 恢复文件#

URL:/files/recover/{fileId}
方法:PUT
参数:
fileId:文件 ID
返回数据:
{
  "code": 200,
  "message": "成功",
  "data": {
    "success": true
  }
}

3.2.10 永久删除文件#

URL:/files/permanent-delete/{fileId}
方法:DELETE
参数:
fileId:文件 ID
返回数据:
{
  "code": 200,
  "message": "成功",
  "data": {
    "success": true
  }
}

3.2.11 导入目录#

URL:/files/import-directory
方法:POST
参数:
{
  "directory_path": "D:/Documents",  // 目录路径
  "parent_file_id": "folder_root"     // 父文件夹 ID
}
返回数据:
{
  "code": 200,
  "message": "成功",
  "data": {
    "success": true,
    "imported_files": 10
  }
}

3.2.12 收藏文件#

URL:/files/favorite/{fileId}
方法:POST
参数:
{
  "is_favorite": true  // 是否收藏
}
返回数据:
{
  "code": 200,
  "message": "成功",
  "data": {
    "success": true
  }
}

3.2.13 根据路径获取文件 ID#

URL:/files/id-by-path
方法:GET
参数:
path:文件路径
返回数据:
{
  "code": 200,
  "message": "成功",
  "data": {
    "file_id": "file_456"
  }
}
修改于 2026-01-21 20:44:58
上一页
3.1 系统相关API
下一页
3.3 媒体相关API
Built with