端点

/api/file/copyFile

复制文件/目录 API (`/api/file/copyFile`)

在 GitHub 上查看源码 返回文件 API 列表 返回 API 主页

接口描述

拷贝工作空间中的单个文件。

注意: 路径参数相对于工作空间根目录。要操作 data 目录下的文件，路径必须以 data/ 开头。要操作临时目录 temp 下的文件，路径必须以 temp/ 开头。

请求

方法: POST

路径: `/api/file/copyFile`

认证: 需要 Token

请求体 (JSON)

参数	类型	必需	描述
`src`	string	是	源文件路径，相对于工作空间根目录。例如 data/assets/source.png 或 temp/template.zip。必须包含正确的路径前缀。
`dest`	string	是	目标文件路径，相对于工作空间根目录。例如 data/assets/destination.png 或 data/widgets/new-widget/template.zip。必须包含正确的路径前缀。

请求示例

拷贝数据目录下的文件:

{
    "src": "data/assets/image.jpg",
    "dest": "data/assets/image_copy.jpg"
}

将临时文件拷贝到数据目录:

{
    "src": "temp/config_backup.json",
    "dest": "data/conf/config.json"
}

响应

成功响应 (200 OK)

成功复制后，返回一个空数据对象。

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

失败响应

如果请求失败（例如，源文件不存在、目标路径已存在、路径无效、权限不足等），将返回错误信息。

{
    "code": -1,
    "msg": "Source file not found [path=...]", // 或 "Target path exists [path=...]", "Invalid path [...]", "Copy file failed: ..."
    "data": null
}

在线测试

src (必填):

dest (必填):

发送请求

测试结果:

© 2023 Siyuan Note API 文档