删除文件/目录 API (`/api/file/removeFile`)

接口描述

删除工作空间中的指定文件或目录。

注意: 路径参数相对于工作空间根目录。要删除 data 目录下的文件/目录,路径必须以 data/ 开头。要删除临时目录 temp 下的文件/目录,路径必须以 temp/ 开头。删除其他受限目录可能会失败。

警告: 删除操作是不可逆的,请谨慎使用!

请求

方法: POST

路径: `/api/file/removeFile`

认证: 需要 Token

请求体 (JSON)

参数 类型 必需 描述
`path` string 要删除的文件或目录路径,相对于工作空间根目录。例如 data/assets/image-to-delete.pngtemp/old-archive.zip必须包含正确的路径前缀 (如 data/temp/)。

请求示例

删除数据目录下的文件:

{
    "path": "data/assets/obsolete-image.jpg"
}

删除临时目录下的目录 (会删除目录及其所有内容):

{
    "path": "temp/unzipped-files"
}

响应

成功响应 (200 OK)

成功删除后,返回一个空数据对象。

{
    "code": 0,
    "msg": "",
    "data": null
}

失败响应

如果请求失败(例如,路径无效、文件或目录不存在、权限不足等),将返回错误信息。

{
    "code": -1,
    "msg": "Remove file failed: remove [...] The system cannot find the file specified.", // 或 "Invalid path [...]"
    "data": null
}

在线测试

测试结果:

注意:这是一个社区维护的文档,可能与官方最新版本存在差异。

如果您觉得本文档有帮助,可以考虑赞助支持:爱发电