接口描述
重命名或移动工作空间中的文件或目录。
注意: 路径参数相对于工作空间根目录。要操作 data
目录下的文件/目录,路径必须以 data/
开头。要操作临时目录 temp
下的文件/目录,路径必须以 temp/
开头。
请求
方法: POST
路径: `/api/file/renameFile`
认证: 需要 Token
请求体 (JSON)
参数 | 类型 | 必需 | 描述 |
---|---|---|---|
`oldPath` | string | 是 | 旧的文件或目录路径,相对于工作空间根目录。例如 data/assets/old-name.png 或 temp/temp-file.zip 。必须包含正确的路径前缀。 |
`newPath` | string | 是 | 新的文件或目录路径,相对于工作空间根目录。例如 data/assets/new-name.png 或 data/widgets/my-widget 。必须包含正确的路径前缀。 |
请求示例
重命名数据目录下的文件:
{
"oldPath": "data/assets/image.jpg",
"newPath": "data/assets/photo.jpg"
}
将临时目录解压出的文件移动到最终位置:
{
"oldPath": "temp/widget-unzipped",
"newPath": "data/widgets/my-new-widget"
}
响应
成功响应 (200 OK)
成功重命名后,返回一个空数据对象。
{
"code": 0,
"msg": "",
"data": null
}
失败响应
如果请求失败(例如,路径无效、文件不存在、新路径已存在、权限不足等),将返回错误信息。
{
"code": -1,
"msg": "Invalid path [...]", // 或 "Rename file failed: ... The system cannot find the file specified.", "Rename file failed: ... The file already exists."
"data": null
}
在线测试
测试结果: